Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://rest.test.zuora.com
https://rest.sandbox.na.zuora.com
https://rest.apisandbox.zuora.com
https://rest.na.zuora.com
https://rest.zuora.com
https://rest.test.eu.zuora.com
https://rest.sandbox.eu.zuora.com
https://rest.eu.zuora.com
/objects/jobs/{id}/cancel
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`.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| Zuora-Version | header | optional | string | API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. |
| id | path | required | string | The ID of the custom object bulk job that you want to cancel. |
PATCH /objects/jobs/{id}/cancel
/objects/records/default/{object}/{id}
Updates one or many fields of a custom object record. Patch update uses JSON Merge Patch as specified in [RFC 7386](https://tools.ietf.org/html/rfc7386). ### Limitations * The storage of empty strings in records is not supported. * Null values must be formatted as the following example: ``` { "records": [ { "fieldName__c": null } ] } ``` * When creating or updating custom object records with relationship-type fields, Zuora verifies the related objects against the transactional databases, which are updated in near real-time. The record creation or modification fails upon unsuccessful verifications. <br />If the related objects are newly created in your tenant, it might need some time for the transactional database synchronization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| Zuora-Version | header | optional | string | API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. |
| object | path | required | string | Specifies the custom object's API name as object. It is case-sensitive. |
| id | path | required | string | Id identifier in uuid form |
{
"content": {
"application/merge-patch+json": {
"schema": {
"$ref": "#/components/schemas/CustomObjectRecordWithOnlyCustomFields"
}
}
},
"required": true
}
PATCH /objects/records/default/{object}/{id}
/workflows/{workflow_id}
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. ### User Access Permission You must be assigned the **Workflow Manage Access** permission to run this operation.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| optional | ||||
| workflow_id | path | required | string | The unique ID of a workflow definition. For example, 19080. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchUpdateWorkflowRequest"
}
}
}
}
PATCH /workflows/{workflow_id}
AccountCreditCardHolder
{
"type": "object",
"properties": {
"city": {
"type": "string",
"maxLength": 40,
"description": "City of the cardholder's address.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"email": {
"type": "string",
"maxLength": 80,
"description": "Email address of the cardholder.\n"
},
"phone": {
"type": "string",
"maxLength": 40,
"description": "Phone number of the cardholder.\n"
},
"state": {
"type": "string",
"maxLength": 50,
"description": "State or province of the cardholder's address.\n"
},
"country": {
"type": "string",
"maxLength": 64,
"description": "Country of the cardholder's address. The value of this field must be a valid country name or abbreviation.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"zipCode": {
"type": "string",
"maxLength": 20,
"description": "ZIP code or other postal code of the cardholder's address.\n"
},
"addressLine1": {
"type": "string",
"maxLength": 255,
"description": "First line of the cardholder's address.\n"
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"description": "Second line of the cardholder's address.\n"
},
"cardHolderName": {
"type": "string",
"maxLength": 50,
"description": "Full name of the cardholder as it appears on the card. For example, \"John J Smith\".\n"
}
},
"description": "Information about the cardholder of a credit card payment method associated with an account. If you do not provide information about the cardholder, Zuora uses the account's bill-to contact.\n"
}
AccountData
{
"type": "object",
"required": [
"billCycleDay",
"billToContact",
"currency",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255
},
"batch": {
"type": "string",
"description": "**Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite\" target=\"_blank\">Performance Booster Elite</a> package.\n"
},
"crmId": {
"type": "string",
"maxLength": 100
},
"notes": {
"type": "string",
"maxLength": 65535
},
"autoPay": {
"type": "boolean",
"description": "Specifies whether future payments are to be automatically billed when they are due. Possible values are `true`, `false`."
},
"taxInfo": {
"$ref": "#/components/schemas/SignUpTaxInfo"
},
"currency": {
"type": "string",
"description": "3 uppercase character currency code.\n\nFor payment method authorization, if the `paymentMethod` > `currencyCode` field is specified, `currencyCode` is used. Otherwise, this `currency` field is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used.\n"
},
"paymentTerm": {
"type": "string"
},
"billCycleDay": {
"type": "integer",
"maximum": 31,
"minimum": 0,
"description": "Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\"."
},
"customFields": {
"$ref": "#/components/schemas/CustomFields"
},
"accountNumber": {
"type": "string",
"maxLength": 70
},
"billToContact": {
"$ref": "#/components/schemas/ContactInfo"
},
"paymentMethod": {
"$ref": "#/components/schemas/SignUpPaymentMethod"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the billing document sequence set to assign to the customer account. \n\nThe billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.\n"
},
"soldToContact": {
"$ref": "#/components/schemas/ContactInfo"
},
"invoiceTemplateId": {
"type": "string"
},
"debitMemoTemplateId": {
"type": "string",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThe unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.\n"
},
"purchaseOrderNumber": {
"type": "string",
"maxLength": 100,
"description": "The number of the purchase order associated with this account. Purchase order information generally comes from customers.\n"
},
"creditMemoTemplateId": {
"type": "string",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThe unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.\n"
},
"communicationProfileId": {
"type": "string"
}
},
"description": "The information of the account that you are to create through the \"Sign up\" operation.\n"
}
AccountObjectCustomFields
{
"type": "object",
"title": "accountFieldsCustom",
"description": "Container for custom fields of an Account object.\n",
"additionalProperties": {
"description": "Custom fields of the Account object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
AccountObjectNSFields
{
"type": "object",
"title": "accountFieldsNetSuite",
"properties": {
"Class__NS": {
"type": "string",
"maxLength": 255,
"description": "Value of the Class field for the corresponding customer account in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"Location__NS": {
"type": "string",
"maxLength": 255,
"description": "Value of the Location field for the corresponding customer account in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"SyncDate__NS": {
"type": "string",
"maxLength": 255,
"description": "Date when the account was sychronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"Department__NS": {
"type": "string",
"maxLength": 255,
"description": "Value of the Department field for the corresponding customer account in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"Subsidiary__NS": {
"type": "string",
"maxLength": 255,
"description": "Value of the Subsidiary field for the corresponding customer account in NetSuite. The Subsidiary field is required if you use NetSuite OneWorld. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"CustomerType__NS": {
"enum": [
"Company",
"Individual"
],
"type": "string",
"description": "Value of the Customer Type field for the corresponding customer account in NetSuite. The Customer Type field is used when the customer account is created in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationId__NS": {
"type": "string",
"maxLength": 255,
"description": "ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"SynctoNetSuite__NS": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Specifies whether the account should be synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationStatus__NS": {
"type": "string",
"maxLength": 255,
"description": "Status of the account's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
},
"description": "Container for Account fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
AccountingCodeObjectCustomFields
{
"type": "object",
"title": "accountingCodeFieldsCustom",
"description": "Container for custom fields of an Accounting Code object.\n",
"additionalProperties": {
"description": "Custom fields of the Accounting Code object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
AccountingPeriodObjectCustomFields
{
"type": "object",
"title": "accountingPeriodFieldsCustom",
"description": "Container for custom fields of an Accounting Period object.\n",
"additionalProperties": {
"description": "Custom fields of the Accounting Period object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
ActionPosTcreateResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SaveResult"
},
"description": ""
}
ActionPosTdeleteResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/DeleteResult"
},
"description": ""
}
ActionPosTupdateResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SaveResult"
},
"description": ""
}
ActionsErrorResponse
{
"type": "object",
"properties": {
"Code": {
"type": "string",
"description": ""
},
"Message": {
"type": "string",
"description": ""
}
}
}
ApiVolumeSummaryRecord
{
"allOf": [
{
"type": "object",
"properties": {
"api": {
"type": "string",
"description": "The API path name.\n"
},
"error": {
"type": "integer",
"description": "The count of failed API requests of above `api` and `httpMethod`.\n"
},
"total": {
"type": "integer",
"description": "The count of total API requests of above `api` and `httpMethod`."
},
"success": {
"type": "integer",
"description": "The count of successful API requests of above `api` and `httpMethod`.\n"
},
"httpMethod": {
"type": "string",
"description": "The http method.\n"
}
}
}
],
"title": "volumeSummaryRecord",
"description": "A volume summary record.\n"
}
ApplyCreditMemoType
{
"type": "object",
"example": {
"invoices": [
{
"items": [
{
"amount": 0.9,
"invoiceItemId": "4028905f5a87c0ff015a87d3f90c0045",
"creditMemoItemId": "4028905f5a890526015a8d73f74b0016"
},
{
"amount": 0.1,
"taxItemId": "4028905f5a87c0ff015a87d3f884003f",
"creditTaxItemId": "4028905f5a890526015a8d73f90c0018"
}
],
"amount": 1,
"invoiceId": "4028905f5a87c0ff015a87d3f8f10043"
}
],
"effectiveDate": "2017-03-02"
},
"properties": {
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoApplyInvoiceRequestType"
},
"description": "Container for invoices that the credit memo is applied to. The maximum number of invoices is 1,000.\n"
},
"debitMemos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoApplyDebitMemoRequestType"
},
"description": "Container for debit memos that the credit memo is applied to. The maximum number of debit memos is 1,000.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the credit memo is applied.\n"
}
}
}
ApplyPaymentType
{
"type": "object",
"example": {
"invoices": [
{
"items": [
{
"amount": 10,
"invoiceItemId": "4028905f5a87c0ff015a87d3f90c0045"
},
{
"amount": 0.1,
"taxItemId": "4028905f5a87c0ff015a87d3f884003f"
}
],
"amount": 10.1,
"invoiceId": "4028905f5a87c0ff015a87d3f8f10043"
}
],
"debitMemos": [
{
"items": [
{
"amount": 1,
"debitMemoItemId": "4028905f5a87c0ff015a87e49e7a0063"
},
{
"amount": 0.02,
"taxItemId": "4028905f5a87c0ff015a87e49f5e0065"
}
],
"amount": 1.02,
"debitMemoId": "4028905f5a87c0ff015a87e49e6b0062"
}
],
"effectiveDate": "2017-03-01"
},
"properties": {
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentInvoiceApplicationApplyRequestType"
},
"description": "Container for invoices. The maximum number of invoices is 1,000.\n"
},
"debitMemos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentDebitMemoApplicationApplyRequestType"
},
"description": "Container for debit memos. The maximum number of debit memos is 1,000.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the payment application takes effect, in `yyyy-mm-dd` format. The effective date must be later than or equal to the maximum effective date of the payment.\n"
}
}
}
BadRequestResponse
{
"type": "object",
"properties": {
"Errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The error code."
},
"title": {
"type": "string",
"description": "The reason for the error."
},
"status": {
"type": "string",
"description": "The status of the response."
}
}
}
}
}
}
BatchDebitMemoType
{
"type": "object",
"title": "debitMemos",
"properties": {
"id": {
"type": "string",
"description": "The unique ID or number of the debit memo to be updated. For example, 402890555a87d7f5015a892f2ba10057 or or DM00000001.\n"
},
"dueDate": {
"type": "string",
"format": "date",
"description": "The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format.\n"
}
}
}
BatchInvoiceType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the invoice to be updated.\n"
},
"autoPay": {
"type": "boolean",
"description": "Whether invoices are automatically picked up for processing in the corresponding payment run.\n\nBy default, invoices are automatically picked up for processing in the corresponding payment run.\n"
},
"dueDate": {
"type": "string",
"format": "date",
"description": "The date by which the payment for this invoice is due.\n"
},
"comments": {
"type": "string",
"maxLength": 255,
"description": "Additional information related to the invoice that a Zuora user added to the invoice.\n"
},
"invoiceDate": {
"type": "string",
"format": "date",
"description": "The new invoice date of the invoice. The new invoice date cannot fall in a closed accounting period.\n\nYou can only specify `invoiceDate` or `dueDate` in one request. Otherwise, an error occurs.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutInvoiceItemType"
},
"description": "Container for invoice items. The maximum number of items is 1,000.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the invoice was transferred to an external accounting system.\n"
}
}
},
{
"$ref": "#/components/schemas/InvoiceObjectNSFields"
},
{
"$ref": "#/components/schemas/InvoiceObjectCustomFields"
}
],
"title": "invoices"
}
BatchQueries
{
"title": "batch",
"properties": {
"name": {
"type": "string",
"description": "Name of the query supplied in the request.\n"
},
"query": {
"type": "string",
"description": "The requested query string.\n"
},
"fileId": {
"type": "string",
"description": "The ID of the query results file.\n\nUse Get Results Files to download the query results file. The query results file is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP.\n"
},
"status": {
"enum": [
"submitted",
"pending",
"executing",
"completed",
"aborted",
"deleted_notallowed"
],
"type": "string",
"description": "The status of the query task:\n- submitted: The query was submitted to the query executor for processing.\n- pending: The query was waiting for being processed.\n- executing: The query is being processed.\n- completed: The query was successfully executed.\n- aborted: The query execution failed.\n- deleted_notallowed: The query execution failed because objects included in the query do not support the querying of deleted records.\n"
},
"batchId": {
"type": "string",
"description": "A 32-character ID of the query batch.\n"
},
"message": {
"type": "string",
"maximum": 2048,
"description": "The error message.\n"
},
"segments": {
"type": "array",
"items": {},
"description": "Array of IDs of query results files. Replaces fileId for full data loads in stateful mode if <a href = \"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/G_File_Segmentation\" target=\"_blank\">File Segmentation</a> is enabled.\n\nUse Get Results Files to download each query results file. Each query results file contains at most 500,000 records and is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP.\n"
},
"batchType": {
"enum": [
"zoql",
"zoqlexport"
],
"type": "string",
"description": "The kind of batch job being submitted. \n"
},
"recordCount": {
"type": "string",
"description": "The number of records included in the query output file.\n"
}
}
}
BatchQuery
{
"title": "query",
"properties": {
"name": {
"type": "string",
"description": "The query name that can uniquely identify the query in this API request.\n"
},
"type": {
"enum": [
"zoql",
"zoqlexport"
],
"type": "string",
"description": "The query type.\n"
},
"query": {
"type": "string",
"description": "A valid ZOQL query or Export ZOQL query statement.\n"
},
"deleted": {
"type": "array",
"items": {
"type": "object",
"title": "deletedRecord",
"properties": {
"column": {
"type": "string",
"description": "Name of the Column in the extracted file that points to the deleted records. \n"
},
"format": {
"type": "string",
"description": "Can be set to either `Numeric` or `Boolean`. If set to `Numeric`, deleted records are marked as `1`. If set to `Boolean`, deleted records are marked as `true`.\n"
}
}
},
"description": "This field indicates that the AQuA incremental load will retrieve deleted records.\n\nIf you want to export deleted data, this field is required.\n\n**Note**: AQuA API is subject to Zuora Data Retention Policy. The retention period of deleted data is 30 days. You can only retrieve deleted data for 30 days through AQuA.\n"
},
"apiVersion": {
"type": "string",
"description": "The API version for the query. If an API version is not specified, the latest version is used by default. Using the latest WSDL version is most useful for reporting use cases. For integration purposes, specify the WSDL version to ensure consistent query behavior, that is, what is supported and included in the response returned by the API.\n\n**Note**: As of API version 69 and later, Zuora changed the format of certain fields. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/G_SOAP_API/AB_Getting_started_with_the__SOAP_API/C_Date_Field_Changes_in_the_SOAP_API\" target=\"_blank\">Date Field Changes in the SOAP API</a> for more information and a list of affected fields.\n"
},
"convertToCurrencies": {
"type": "string",
"description": "The currencies that you want to convert transaction amounts into. You can specify any number of currencies. Specify the currencies using their <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/D_Currencies_and_Their_3-Letter_Codes\" target=\"_blank\">ISO currency codes</a> and separate each currency with a comma, for example, \"EUR,GBP,JPY\".\n\nSee <a href=\"https://knowledgecenter.zuora.com/Zuora_Collect/Zuora_Finance/D_Finance_Settings/F_Foreign_Currency_Conversion/Foreign_Currency_Conversion_for_Data_Source_Exports#Creating_the_Data_Source_Export_Using_the_AQuA_API\" target=\"_blank\">Convert Transaction Amounts Into Any Currency</a> for more information and examples.\n\nTo use this field, you must have <a href=\"https://knowledgecenter.zuora.com/Zuora_Collect/Zuora_Finance/D_Finance_Settings/F_Foreign_Currency_Conversion\" target=\"_blank\">Foreign Currency Conversion</a> enabled and you must be using API version 78 or later.\n"
}
}
}
BatchesQueries
{
"title": "batch",
"properties": {
"full": {
"type": "boolean",
"description": "This field indicates a full or incremental load. `True` = Full and `False` = Incremental. \n"
},
"name": {
"type": "string",
"description": "Name of the query supplied in the request.\n"
},
"query": {
"type": "string",
"description": "The requested query string.\n"
},
"status": {
"enum": [
"submitted",
"pending",
"executing",
"completed",
"aborted",
"deleted_notallowed"
],
"type": "string",
"description": "The status of the query task:\n- submitted: The query was submitted to the query executor for processing.\n- pending: The query was waiting for being processed.\n- executing: The query is being processed.\n- completed: The query was successfully executed.\n- aborted: The query execution failed.\n- deleted_notallowed: The query execution failed because objects included in the query do not support the querying of deleted records.\n"
},
"batchId": {
"type": "string",
"description": "A 32-character ID of the query batch.\n"
},
"deleted": {
"type": "array",
"items": {
"type": "object",
"title": "deletedRecord",
"properties": {
"column": {
"type": "string",
"description": "Name of the Column in the extracted file that points to the deleted records. \n"
},
"format": {
"type": "string",
"description": "Can be set to either `Numeric` or `Boolean`. If set to `Numeric`, deleted records are marked as `1`. If set to `Boolean`, deleted records are marked as `true`. \n"
}
}
},
"description": "This field indicates that the AQuA incremental load will retrieve deleted records.\n\n**Note**: AQuA API is subject to Zuora Data Retention Policy. The retention period of deleted data is 30 days. You can only retrieve deleted data for 30 days through AQuA.\n"
},
"batchType": {
"enum": [
"zoql",
"zoqlexport"
],
"type": "string",
"description": "The kind of batch job being submitted.\n"
},
"apiVersion": {
"type": "string",
"description": "The API version for the query. If an API version is not specified, the latest version is used by default. Using the latest WSDL version is most useful for reporting use cases. For integration purposes, specify the WSDL version to ensure consistent query behavior, that is, what is supported and included in the response returned by the API.\n\n**Note**: As of API version 69 and later, Zuora changed the format of certain fields. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/G_SOAP_API/AB_Getting_started_with_the__SOAP_API/C_Date_Field_Changes_in_the_SOAP_API\" target=\"_blank\">Date Field Changes in the SOAP API</a> for more information and a list of affected fields.\n"
},
"recordCount": {
"type": "string",
"description": "The number of records included in the query output file.\n"
}
}
}
BatchesQueriesById
{
"title": "batch",
"properties": {
"full": {
"type": "boolean",
"description": "This field indicates a full or incremental load. `True` = Full and `False` = Incremental.\n"
},
"name": {
"type": "string",
"description": "Name of the query supplied in the request.\n"
},
"query": {
"type": "string",
"description": "The requested query string.\n"
},
"fileId": {
"type": "string",
"description": "The ID of the query results file.\n\nUse Get Results Files to download the query results file. The query results file is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP.\n"
},
"status": {
"enum": [
"submitted",
"pending",
"executing",
"completed",
"aborted",
"deleted_notallowed"
],
"type": "string",
"description": "The status of the query task:\n- submitted: The query was submitted to the query executor for processing.\n- pending: The query was waiting for being processed.\n- executing: The query is being processed.\n- completed: The query was successfully executed.\n- aborted: The query execution failed.\n- deleted_notallowed: The query execution failed because objects included in the query do not support the querying of deleted records.\n"
},
"batchId": {
"type": "string",
"description": "A 32-character ID of the query batch.\n"
},
"message": {
"type": "string",
"maximum": 2048,
"description": "The error message.\n"
},
"segments": {
"type": "array",
"items": {},
"description": "Array of IDs of query results files. Replaces fileId for full data loads in stateful mode if <a href = \"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/G_File_Segmentation\" target=\"_blank\">File Segmentation</a> is enabled.\n\nUse Get Results Files to download each query results file. Each query results file contains at most 500,000 records and is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP.\n"
},
"batchType": {
"enum": [
"zoql",
"zoqlexport"
],
"type": "string",
"description": "The kind of batch job being submitted.\n"
},
"apiVersion": {
"type": "string",
"description": "The API version for the query. If an API version is not specified, the latest version is used by default. Using the latest WSDL version is most useful for reporting use cases. For integration purposes, specify the WSDL version to ensure consistent query behavior, that is, what is supported and included in the response returned by the API.\n\n**Note**: As of API version 69 and later, Zuora changed the format of certain fields. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/G_SOAP_API/AB_Getting_started_with_the__SOAP_API/C_Date_Field_Changes_in_the_SOAP_API\" target=\"_blank\">Date Field Changes in the SOAP API</a> for more information and a list of affected fields.\n"
},
"recordCount": {
"type": "string",
"description": "The number of records included in the query output file.\n"
}
}
}
BillRunFilterRequestType
{
"allOf": [
{
"type": "object",
"required": [
"accountId",
"filterType"
],
"properties": {
"accountId": {
"type": "string",
"description": "The target account of the bill run. \n\nIf multiple subscriptions are specified, the account ID must be the same.\n"
},
"filterType": {
"enum": [
"Account",
"Subscription"
],
"type": "string",
"description": "To create bill runs at account level or subscription level.\n"
},
"subscriptionId": {
"type": "string",
"description": "The target subscripiton ID of the account. \n\nIf you set the `filterType` field to `Subscription`, you must specify the `subscriptionId` field.\n"
}
}
}
],
"title": "billRunFilters"
}
BillRunFilterResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "The target account of the bill run.\n"
},
"filterType": {
"enum": [
"Account",
"Subscription"
],
"type": "string",
"description": "To create bill run at account level or subscription level.\n"
},
"subscriptionId": {
"type": "string",
"description": "The target subscripiton ID of the account. \n"
}
}
}
],
"title": "billRunFilters"
}
BillRunFilters
{
"allOf": [
{
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "The target account of the bill run.\n"
},
"filterType": {
"enum": [
"Account",
"Subscription",
"InvoiceSchedule"
],
"type": "string",
"description": "The type of the filter to determine whether to create a bill run at the account level or subscription level.\n"
},
"subscriptionId": {
"type": "string",
"description": "The unique ID of the target subscription belonged to the target account. \n\nThis field is required if you set the `filterType` field to `Subscription`.\n"
}
}
},
{}
],
"title": "billRunFilters"
}
BillRunScheduleRequestType
{
"allOf": [
{
"type": "object",
"required": [
"repeatFrom",
"repeatType",
"runTime"
],
"properties": {
"runTime": {
"type": "integer",
"description": "The scheduled run time (hour) of day.\n\n**Values:** 0 - 23\n"
},
"repeatTo": {
"type": "string",
"format": "date",
"description": "The end date of of the scheduled bill run.\n"
},
"repeatFrom": {
"type": "string",
"format": "date",
"description": "The start date of the scheduled bill run.\n"
},
"repeatType": {
"enum": [
"None",
"Daily",
"Weekly",
"Monthly"
],
"type": "string",
"description": "The repeat type of the bill run.\n"
},
"weeklyOnDay": {
"type": "array",
"items": {
"enum": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri",
"Sat",
"Sun"
],
"type": "string"
},
"description": "The repeat day in a week. \n\nThis field is required if you set `repeatType` field to `Weekly`.\n"
}
},
"description": "Container for information about the scheduled bill run.\n"
}
],
"title": "schedule"
}
BillRunScheduleResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"runTime": {
"type": "integer",
"description": "The scheduled run time (hour) of day.\n\n**Values:** 0 - 23\n"
},
"repeatTo": {
"type": "string",
"format": "date",
"description": "The end date of of the scheduled bill run.\n"
},
"repeatFrom": {
"type": "string",
"format": "date",
"description": "The start date of the scheduled bill run.\n"
},
"repeatType": {
"enum": [
"None",
"Daily",
"Weekly",
"Monthly"
],
"type": "string",
"description": "The repeat type of the bill run.\n"
},
"weeklyOnDay": {
"type": "array",
"items": {
"enum": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri",
"Sat",
"Sun"
],
"type": "string"
},
"description": "The repeat day in a week.\n"
}
},
"description": "Container for information about the scheduled bill run.\n"
}
],
"title": "schedule"
}
BillToContact
{
"allOf": [
{
"type": "object",
"required": [
"firstName",
"lastName"
],
"properties": {
"fax": {
"type": "string",
"maxLength": 40,
"description": "Fax number of the contact.\n"
},
"city": {
"type": "string",
"maxLength": 40,
"description": "City of the contact's address.\n"
},
"state": {
"type": "string",
"maxLength": 40,
"description": "State or province of the contact's address.\n"
},
"county": {
"type": "string",
"maxLength": 32,
"description": "County of the contact's address.\n"
},
"country": {
"type": "string",
"maxLength": 64,
"description": "Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the bill-to contact to calculate tax.\n"
},
"address1": {
"type": "string",
"maxLength": 255,
"description": "First line of the contact's address. This is often a street address or a business name.\n"
},
"address2": {
"type": "string",
"maxLength": 255,
"description": "Second line of the contact's address.\n"
},
"lastName": {
"type": "string",
"maxLength": 100,
"description": "Last name of the contact.\n"
},
"nickname": {
"type": "string",
"maxLength": 100,
"description": "Nickname of the contact.\n"
},
"firstName": {
"type": "string",
"maxLength": 100,
"description": "First name of the contact.\n"
},
"homePhone": {
"type": "string",
"maxLength": 40,
"description": "Home phone number of the contact.\n"
},
"taxRegion": {
"type": "string",
"maxLength": 32,
"description": "Region defined in your taxation rules. Only applicable if you use Zuora Tax.\n"
},
"workEmail": {
"type": "string",
"format": "email",
"maxLength": 80,
"description": "Business email address of the contact.\n"
},
"workPhone": {
"type": "string",
"maxLength": 40,
"description": "Business phone number of the contact.\n"
},
"otherPhone": {
"type": "string",
"maxLength": 40,
"description": "Additional phone number of the contact. Use the `otherPhoneType` field to specify the type of phone number.\n"
},
"postalCode": {
"type": "string",
"maxLength": 20,
"description": "ZIP code or other postal code of the contact's address.\n"
},
"mobilePhone": {
"type": "string",
"maxLength": 40,
"description": "Mobile phone number of the contact.\n"
},
"personalEmail": {
"type": "string",
"format": "email",
"maxLength": 80,
"description": "Personal email address of the contact.\n"
},
"otherPhoneType": {
"enum": [
"Work",
"Mobile",
"Home",
"Other"
],
"type": "string",
"description": "Specifies the type of phone number in the `otherPhone` field.\n"
}
},
"description": "Contact details associated with an account.\n"
},
{
"$ref": "#/components/schemas/ContactObjectCustomFields"
}
]
}
BillToContactPostOrder
{
"allOf": [
{
"type": "object",
"required": [
"firstName",
"lastName"
],
"properties": {
"fax": {
"type": "string",
"maxLength": 40,
"description": "Fax number of the contact.\n"
},
"city": {
"type": "string",
"maxLength": 40,
"description": "City of the contact's address.\n"
},
"state": {
"type": "string",
"maxLength": 40,
"description": "State or province of the contact's address.\n"
},
"county": {
"type": "string",
"maxLength": 32,
"description": "County of the contact's address.\n"
},
"country": {
"type": "string",
"maxLength": 64,
"description": "Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the bill-to contact to calculate tax.\n"
},
"address1": {
"type": "string",
"maxLength": 255,
"description": "First line of the contact's address. This is often a street address or a business name.\n"
},
"address2": {
"type": "string",
"maxLength": 255,
"description": "Second line of the contact's address.\n"
},
"lastName": {
"type": "string",
"maxLength": 100,
"description": "Last name of the contact.\n"
},
"nickname": {
"type": "string",
"maxLength": 100,
"description": "Nickname of the contact.\n"
},
"firstName": {
"type": "string",
"maxLength": 100,
"description": "First name of the contact.\n"
},
"homePhone": {
"type": "string",
"maxLength": 40,
"description": "Home phone number of the contact.\n"
},
"taxRegion": {
"type": "string",
"maxLength": 32,
"description": "Region defined in your taxation rules. Only applicable if you use Zuora Tax.\n"
},
"workEmail": {
"type": "string",
"format": "email",
"maxLength": 80,
"description": "Business email address of the contact.\n"
},
"workPhone": {
"type": "string",
"maxLength": 40,
"description": "Business phone number of the contact.\n"
},
"otherPhone": {
"type": "string",
"maxLength": 40,
"description": "Additional phone number of the contact. Use the `otherPhoneType` field to specify the type of phone number.\n"
},
"postalCode": {
"type": "string",
"maxLength": 20,
"description": "ZIP code or other postal code of the contact's address.\n"
},
"mobilePhone": {
"type": "string",
"maxLength": 40,
"description": "Mobile phone number of the contact.\n"
},
"personalEmail": {
"type": "string",
"format": "email",
"maxLength": 80,
"description": "Personal email address of the contact.\n"
},
"otherPhoneType": {
"enum": [
"Work",
"Mobile",
"Home",
"Other"
],
"type": "string",
"description": "Specifies the type of phone number in the `otherPhone` field.\n"
},
"contactDescription": {
"type": "string",
"maxLength": 100,
"description": "A description for the contact.\n"
}
},
"description": "Contact details associated with an account.\n"
},
{
"$ref": "#/components/schemas/ContactObjectCustomFields"
}
]
}
BillingDocVolumeSummaryRecord
{
"allOf": [
{
"type": "object",
"properties": {
"totalFailedAccounts": {
"type": "integer",
"description": "The count of total accounts who have failed records."
},
"totalGeneratedInvoices": {
"type": "integer",
"description": "The count of total generated invoices.\n"
},
"totalGeneratedCreditMemos": {
"type": "integer",
"description": "The count of total generated credit memos.\n"
}
}
}
],
"title": "volumeSummaryRecord",
"description": "A volume summary record.\n"
}
BillingDocumentQueryResponseElementType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETBillingDocumentsResponseType"
},
"description": "Container for billing documents.\n"
}
}
}
BillingOptions
{
"type": "object",
"properties": {
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges for order line items if a billing document is generated. See [What is a Target Date?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/G_Bill_Runs/Creating_Bill_Runs#What_is_a_Target_Date.3F)."
},
"documentDate": {
"type": "string",
"format": "date",
"description": "The invoice date displayed on the billing document."
}
}
}
BillingPreviewResult
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"accountId": {
"type": "string",
"description": "ID of the customer account to which the billing preview applies.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTBillingPreviewInvoiceItem"
},
"description": "An array of invoice items returned as the result of the billing preview request.\n"
},
"creditMemoItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTBillingPreviewCreditMemoItem"
},
"description": "An array of credit memo items returned as the result of the billing preivew request.\n\n**Note:** The credit memo items are only available if you have Invoice Settlement feature 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
}
}
}
BillingUpdate
{
"type": "object",
"properties": {
"billingPeriodAlignment": {
"enum": [
"AlignToCharge",
"AlignToSubscriptionStart",
"AlignToTermStart"
],
"type": "string"
}
}
}
BodyInSettingValueReponse
{
"type": "object",
"title": "settingsResponseBody",
"description": "Response body if the request is executed successfully.",
"additionalProperties": true
}
BodyInSettingValueRequest
{
"type": "object",
"title": "settingsRequestBody",
"description": "Request payload if any",
"additionalProperties": true
}
BulkCreateCreditMemosFromChargeRequest
{
"type": "object",
"required": [
"sourceType"
],
"properties": {
"memos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoFromChargeRequest"
},
"maxItems": 50,
"description": "The container for a list of credit memos. The maximum number of credit memos is 50.\n"
},
"sourceType": {
"enum": [
"Standalone",
"Invoice"
],
"type": "string",
"description": "The type of the source where credit memos are created. \n \nThis enum field has the following values:\n - `Invoice`: By setting this field to `Invoice`, you can create multiple credit memos from invoices.\n - `Standalone`: By setting this field to `Standalone`, you can create multiple credit memos from product rate plan charges.\n \nThe specific schema of the `memos` object field in the request body depends on the value of the `sourceType` field.\n - To view the `memos` schema applicable to credit memo creation from invoices, select `Invoice` from the following drop-down list.\n - To view the `memos` schema applicable to credit memo creation from product rate plan charges, select `Standalone` from the following drop-down list.\n"
}
}
}
BulkCreateCreditMemosFromInvoiceRequest
{
"type": "object",
"required": [
"sourceType"
],
"properties": {
"memos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoFromInvoiceRequest"
},
"maxItems": 50,
"description": "The container for a list of credit memos. The maximum number of credit memos is 50.\n"
},
"sourceType": {
"enum": [
"Invoice"
],
"type": "string",
"description": "The type of the source where credit memos are created. \n \nThis enum field has the following values:\n - `Invoice`: By setting this field to `Invoice`, you can create multiple credit memos from invoices.\n - `Standalone`: By setting this field to `Standalone`, you can create multiple credit memos from product rate plan charges.\n \nThe specific schema of the `memos` object field in the request body depends on the value of the `sourceType` field.\n - To view the `memos` schema applicable to credit memo creation from invoices, select `Invoice` from the following drop-down list.\n - To view the `memos` schema applicable to credit memo creation from product rate plan charges, select `Standalone` from the following drop-down list.\n \n"
}
}
}
BulkCreateDebitMemosFromChargeRequest
{
"type": "object",
"required": [
"sourceType"
],
"properties": {
"memos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DebitMemoFromChargeRequest"
},
"maxItems": 50,
"description": "The container for a list of debit memos. The maximum number of debit memos is 50.\n"
},
"sourceType": {
"enum": [
"Standalone"
],
"type": "string",
"description": "The type of the source where debit memos are created. \n \nThis enum field has the following values:\n - `Invoice`: By setting this field to `Invoice`, you can create multiple debit memos from invoices.\n - `Standalone`: By setting this field to `Standalone`, you can create multiple debit memos from product rate plan charges.\n \nThe specific schema of the `memos` object field in the request body depends on the value of the `sourceType` field.\n - To view the `memos` schema applicable to debit memo creation from invoices, select `Invoice` from the following drop-down list.\n - To view the `memos` schema applicable to debit memo creation from product rate plan charges, select `Standalone` from the following drop-down list.\n \n"
}
}
}
BulkCreateDebitMemosFromInvoiceRequest
{
"type": "object",
"required": [
"sourceType"
],
"properties": {
"memos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DebitMemoFromInvoiceRequest"
},
"maxItems": 50,
"description": "The container for a list of debit memos. The maximum number of debit memos is 50.\n"
},
"sourceType": {
"enum": [
"Invoice"
],
"type": "string",
"description": "The type of the source where debit memos are created. \n \nThis enum field has the following values:\n - `Invoice`: By setting this field to `Invoice`, you can create multiple debit memos from invoices.\n - `Standalone`: By setting this field to `Standalone`, you can create multiple debit memos from product rate plan charges.\n \nThe specific schema of the `memos` object field in the request body depends on the value of the `sourceType` field.\n - To view the `memos` schema applicable to debit memo creation from invoices, select `Invoice` from the following drop-down list.\n - To view the `memos` schema applicable to debit memo creation from product rate plan charges, select `Standalone` from the following drop-down list.\n"
}
}
}
BulkCreditMemosResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"memos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETCreditMemoType"
},
"title": "memos",
"maxItems": 50,
"description": "The container for a list of credit memos.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
}
}
}
]
}
BulkDebitMemosResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"memos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETDebitMemoType"
},
"maxItems": 50,
"description": "The container for a list of debit memos.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
}
}
}
]
}
CalloutAuth
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "The domain of the callout auth."
},
"password": {
"type": "string",
"description": "The field is required when `requiredAuth` is `true`."
},
"username": {
"type": "string",
"description": "The field is required when `requiredAuth` is `true`."
},
"preemptive": {
"type": "boolean",
"description": "Set this field to `true` if you want to enable the preemptive authentication."
}
},
"description": "If `requiredAuth` is `true`, this object is required."
}
CalloutMergeFields
{
"type": "object",
"title": "calloutParams",
"description": "A key-value map of merge fields of this callout.\n",
"additionalProperties": {
"type": "string",
"description": "The key is the parameter name. The value is a merge field with angle brackets.\n"
}
}
CancelBillRunResponseType
{
"allOf": [
{
"$ref": "#/components/schemas/GetBillRunResponseType"
},
{
"type": "object",
"properties": {
"nextRun": {
"$ref": "#/components/schemas/NextRunResponseType"
}
}
}
],
"example": {
"id": "2c9890e97e57e546017e706109df04a1",
"name": "test",
"status": "CancelInProgress",
"batches": null,
"nextRun": {
"id": "2c9890077e901749017e95235b13093d",
"status": "Pending",
"batches": null,
"autoPost": false,
"schedule": {
"runTime": 0,
"repeatTo": "2023-01-31",
"repeatFrom": "2022-02-28",
"repeatType": "Monthly",
"weeklyOnDay": null
},
"autoEmail": false,
"targetDate": null,
"autoRenewal": true,
"createdById": "ff808081298c6e5401298c7274a40005",
"createdDate": "2022-01-26 14:47:05",
"invoiceDate": null,
"updatedById": "ff808081298c6e5401298c7274a40005",
"updatedDate": "2022-01-26 14:47:05",
"billCycleDay": null,
"billRunNumber": "BR-00000021",
"billRunFilters": [],
"targetDateOffset": 0,
"invoiceDateOffset": 0,
"chargeTypeToExclude": null,
"scheduledExecutionTime": "2022-02-28 00:00:00",
"noEmailForZeroAmountInvoice": false
},
"success": true,
"autoPost": false,
"schedule": null,
"autoEmail": false,
"targetDate": null,
"autoRenewal": true,
"createdById": "ff808081298c6e5401298c7274a40005",
"createdDate": "2022-01-19 11:28:34",
"invoiceDate": "2022-01-26",
"updatedById": "ff808081298c6e5401298c7274a40005",
"updatedDate": "2022-01-26 14:47:09",
"billCycleDay": null,
"billRunNumber": "BR-00000014",
"billRunFilters": [],
"targetDateOffset": 0,
"invoiceDateOffset": 0,
"chargeTypeToExclude": null,
"scheduledExecutionTime": "2022-01-28 00:00:00",
"noEmailForZeroAmountInvoice": false
}
}
CancelSubscription
{
"type": "object",
"title": "cancelSubscription",
"required": [
"cancellationPolicy"
],
"properties": {
"cancellationPolicy": {
"enum": [
"EndOfCurrentTerm",
"EndOfLastInvoicePeriod",
"SpecificDate"
],
"type": "string"
},
"cancellationEffectiveDate": {
"type": "string",
"format": "date"
}
},
"description": "Information about an order action of type `CancelSubscription`.\n"
}
CatalogGroupResponse
{
"type": "object",
"title": "catalogGroups",
"properties": {
"id": {
"type": "string",
"description": "The ID of the catalog group.\n"
},
"name": {
"type": "string",
"description": "The name of the catalog group.\n"
},
"type": {
"enum": [
"Grading",
"Display"
],
"type": "string",
"description": "The type of the catalog group.\n"
},
"description": {
"type": "string",
"description": "The description of the catalog group.\n"
},
"productRatePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETCatalogGroupProductRatePlanResponse"
},
"description": "The list of product rate plans in the catalog group.\n"
},
"catalogGroupNumber": {
"type": "string",
"description": "The automatically generated number of the catalog group with the CG- perfix. For example, CG-00000001.\n"
}
}
}
ChangePlan
{
"type": "object",
"title": "changePlan",
"properties": {
"subType": {
"enum": [
"Upgrade",
"Downgrade",
"Crossgrade",
"PlanChanged"
],
"type": "string",
"description": "This field is used to choose the sub type for your change plan order action.\n\nHowever, if you do not set this field, the field will be automatically generated by the system according to the following rules:\n\nWhen the old and new rate plans are within the same Grading catalog group:\n* If the grade of new plan is greater than that of the old plan, this is an \"Upgrade\".\n* If the grade of new plan is less than that of the old plan, this is a \"Downgrade\".\n* If the grade of new plan equals that of the old plan, this is a \"Crossgrade\".\n\nWhen the old and new rate plans are not in the same Grading catalog group, or either has no group, this is \"PlanChanged\".\n"
},
"ratePlanId": {
"type": "string",
"description": "ID of the rate plan to remove. This can be the latest version or any history version of ID.\n"
},
"effectivePolicy": {
"enum": [
"EffectiveImmediately",
"EffectiveEndOfBillingPeriod",
"SpecificDate"
],
"type": "string",
"description": "* If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default.\n* If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default.\n* Otherwise, the effective policy is `SpecificDate` by default.\n"
},
"productRatePlanId": {
"type": "string",
"description": "ID of the rate plan to remove. This can be the latest version or any history version of ID.\n"
},
"newProductRatePlan": {
"$ref": "#/components/schemas/ChangePlanRatePlanOverride"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription.\n"
},
"subscriptionRatePlanNumber": {
"type": "string",
"description": "Number of a rate plan for this subscription.\n"
}
},
"description": "Information about an order action of type `ChangePlan`.\n\n**Note**: The change plan type of order action is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.\n"
}
ChangePlanChargeOverride
{
"type": "object",
"title": "charge",
"required": [
"productRatePlanChargeId"
],
"properties": {
"name": {
"type": "string",
"description": "The name of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"billing": {
"type": "object",
"properties": {
"billCycleDay": {
"type": "integer",
"maximum": 31,
"minimum": 0,
"description": "Day of the month that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofMonth`.\n"
},
"billCycleType": {
"enum": [
"DefaultFromCustomer",
"SpecificDayofMonth",
"SubscriptionStartDay",
"ChargeTriggerDay",
"SpecificDayofWeek"
],
"type": "string",
"description": "Specifies how Zuora determines the day that each billing period begins on.\n\n * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.\n * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.\n * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.\n * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.\n * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.\n"
},
"billingPeriod": {
"enum": [
"Month",
"Quarter",
"Semi_Annual",
"Annual",
"Eighteen_Months",
"Two_Years",
"Three_Years",
"Five_Years",
"Specific_Months",
"Subscription_Term",
"Week",
"Specific_Weeks",
"Specific_Days"
],
"type": "string",
"description": "Billing frequency of the charge. The value of this field controls the duration of each billing period.\n\nIf the value of this field is `Specific_Days`, `Specific_Months` or `Specific_Weeks`, use the `specificBillingPeriod` field to specify the duration of each billing period.\n"
},
"billingTiming": {
"enum": [
"IN_ADVANCE",
"IN_ARREARS"
],
"type": "string",
"description": "Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).\n"
},
"weeklyBillCycleDay": {
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string",
"description": "Day of the week that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofWeek`.\n"
},
"specificBillingPeriod": {
"type": "integer",
"description": "Duration of each billing period in months or weeks, depending on the value of the `billingPeriod` field. Only applicable if the value of the `billingPeriod` field is `Specific_Months` or `Specific_Weeks`.\n"
},
"billingPeriodAlignment": {
"enum": [
"AlignToCharge",
"AlignToSubscriptionStart",
"AlignToTermStart"
],
"type": "string",
"description": "Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges.\n\n* `AlignToCharge` - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active.\n* `AlignToSubscriptionStart` - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription.\n* `AlignToTermStart` - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term.\n\nSee the `billCycleType` field for information about how Zuora determines the billing day.\n"
}
},
"description": "Billing information about the charge.\n"
},
"endDate": {
"$ref": "#/components/schemas/EndConditions"
},
"pricing": {
"type": "object",
"properties": {
"discount": {
"$ref": "#/components/schemas/DiscountPricingOverride"
},
"usageTiered": {
"$ref": "#/components/schemas/UsageTieredPricingOverride"
},
"usageVolume": {
"$ref": "#/components/schemas/UsageVolumePricingOverride"
},
"usageFlatFee": {
"$ref": "#/components/schemas/UsageFlatFeePricingOverride"
},
"usageOverage": {
"$ref": "#/components/schemas/UsageOveragePricingOverride"
},
"usagePerUnit": {
"$ref": "#/components/schemas/UsagePerUnitPricingOverride"
},
"oneTimeTiered": {
"$ref": "#/components/schemas/OneTimeTieredPricingOverride"
},
"oneTimeVolume": {
"$ref": "#/components/schemas/OneTimeVolumePricingOverride"
},
"oneTimeFlatFee": {
"$ref": "#/components/schemas/OneTimeFlatFeePricingOverride"
},
"oneTimePerUnit": {
"$ref": "#/components/schemas/OneTimePerUnitPricingOverride"
},
"chargeModelData": {
"$ref": "#/components/schemas/ChargeModelDataOverride"
},
"recurringTiered": {
"$ref": "#/components/schemas/RecurringTieredPricingOverride"
},
"recurringVolume": {
"$ref": "#/components/schemas/RecurringVolumePricingOverride"
},
"recurringFlatFee": {
"$ref": "#/components/schemas/RecurringFlatFeePricingOverride"
},
"recurringPerUnit": {
"$ref": "#/components/schemas/RecurringPerUnitPricingOverride"
},
"recurringDeliveryBased": {
"$ref": "#/components/schemas/RecurringDeliveryPricingOverride"
},
"usageTieredWithOverage": {
"$ref": "#/components/schemas/UsageTieredWithOveragePricingOverride"
}
},
"description": "Pricing information about the charge.\n"
},
"taxCode": {
"type": "string",
"description": "The taxCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"taxMode": {
"type": "string",
"description": "The taxMode of a standalone charge. \n\nValues:\n* `TaxExclusive`\n* `TaxInclusive`\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"pobPolicy": {
"type": "string",
"description": "The pobPolicy of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"startDate": {
"$ref": "#/components/schemas/CreateOrderTriggerParams"
},
"chargeType": {
"type": "string",
"description": "The chargeType of a standalone charge.\n\nSupported charge types:\n\n* `OneTime`\n\n* `Recurring`\n\n* `Usage`\n\n**Note:** This field is available when the <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\"\ntarget=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"isRollover": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe value is either \"True\" or \"False\". It determines whether the rollover fields are needed.\n"
},
"isUnbilled": {
"type": "boolean",
"description": "This field is used to dictate how to perform the accounting during revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"revRecCode": {
"type": "string",
"maxLength": 70,
"description": "Revenue Recognition Code\n"
},
"chargeModel": {
"type": "string",
"description": "The chargeModel of a standalone charge.\n\n\nSupported charge models:\n\n* `FlatFee`\n\n* `PerUnit`\n\n* `Volume`\n\n* `Tiered`\n\n* `DiscountFixedAmount`\n\n* `DiscountPercentage`\n\n\n**Note:** This field is available when the <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\"\ntarget=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"description": {
"type": "string",
"maxLength": 500,
"description": "Description of the charge.\n"
},
"productLine": {
"type": "string",
"description": "The productLine of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"uniqueToken": {
"type": "string",
"maxLength": 50,
"description": "Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.\n"
},
"chargeNumber": {
"type": "string",
"maxLength": 50,
"description": "Charge number of the charge. For example, C-00000307.\n\nIf you do not set this field, Zuora will generate the charge number.\n"
},
"customFields": {
"$ref": "#/components/schemas/RatePlanChargeObjectCustomFields"
},
"drawdownRate": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).\n"
},
"productClass": {
"type": "string",
"description": "The productClass of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"productFamily": {
"type": "string",
"description": "The productFamily of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"rolloverApply": {
"enum": [
"ApplyFirst",
"ApplyLast"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the priority of rollover, which is either first or last.\n"
},
"prepaidQuantity": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).\n"
},
"productCategory": {
"type": "string",
"description": "The productCategory of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"rolloverPeriods": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the number of rollover periods, it is restricted to 3.\n"
},
"validityPeriodType": {
"enum": [
"SUBSCRIPTION_TERM",
"ANNUAL",
"SEMI_ANNUAL",
"QUARTER",
"MONTH"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"isAllocationEligible": {
"type": "boolean",
"description": "This field is used to identify if the charge segment is allocation eligible in revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"rolloverPeriodLength": {
"type": "integer",
"default": null,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period length of the rollover fund.\n"
},
"revRecTriggerCondition": {
"enum": [
"Contract Effective Date",
"Service Activation Date",
"Customer Acceptance Date"
],
"type": "string",
"description": "Specifies the revenue recognition trigger condition.\n\n * `Contract Effective Date` \n * `Service Activation Date`\n * `Customer Acceptance Date`\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "Internal identifier of the product rate plan charge that the charge is based on.\n"
},
"upsellOriginChargeNumber": {
"type": "string",
"description": "The identifier of the original upselling charge associated with the current charge.\n\nFor a termed subscription, you can now use the \"Create an order\" API operation to perform an Add Product order action to make a product quantity upsell for per unit recurring charges. The benefit is that the charge added by this approach will be automatically combined with the original existing charge for which you want to upsell when the subscription is renewed. The approach is as follows:\n* Use an Add Product order action to add a charge that is of the same charge type, charge model, and charge end date as the existing per unit recurring charge for which you want to make a quantity upsell.\n\n* In the preceding charge to add, use the `upsellOriginChargeNumber` field to specify the existing rate plan charge for which you want to make the quantity upsell.\n\nNote that a termed subscription with such upsell charges can not be changed to an evergreen subscription. \n\n**Note**: The Quantity Upsell 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. If you want to join this early adopter program, submit a request at [Zuora Global\n Support](https://support.zuora.com). \n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "Specifies the revenue recognition rule, such as `Recognize upon invoicing` or `Recognize daily over time`.\n"
},
"contractAssetAccountingCode": {
"type": "string",
"description": "The contractAssetAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"productRatePlanChargeNumber": {
"type": "string",
"description": "Number of a product rate-plan charge for this subscription.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The deferredRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> and <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a> features are enabled.\n"
},
"accountReceivableAccountingCode": {
"type": "string",
"description": "The accountReceivableAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a>, <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a>, and <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Get_started_with_Invoice_Settlement/AA_Overview_of_Invoice_Settlement\" target=\"_blank\">Invoice Settlement</a> features are enabled.\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The adjustmentRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The contractLiabilityAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The recognizedRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> and <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a> features are enabled.\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The adjustmentLiabilityAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"unBilledReceivablesAccountingCode": {
"type": "string",
"description": "The unBilledReceivablesAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The contractRecognizedRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charges from revenue accounting.\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
}
},
"description": "Charge associated with a rate plan.\n"
}
ChangePlanRatePlanOverride
{
"type": "object",
"title": "ratePlan",
"properties": {
"uniqueToken": {
"type": "string",
"maxLength": 50,
"description": "Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrdersRatePlanObjectCustomFields"
},
"chargeOverrides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChangePlanChargeOverride"
},
"description": "List of charges associated with the rate plan.\n"
},
"productRatePlanId": {
"type": "string",
"description": "Internal identifier of the product rate plan that the rate plan is based on.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription.\n"
},
"externallyManagedPlanId": {
"type": "string",
"description": "Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n"
},
"clearingExistingFeatures": {
"type": "boolean",
"description": "Specifies whether all features in the rate plan will be cleared.\n"
},
"subscriptionProductFeatures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RatePlanFeatureOverride"
},
"description": "List of features associated with the rate plan.\nThe system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:\n* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.\n* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.\n"
}
},
"description": "Information about the new product rate plan to add. \n"
}
ChargeModelConfigurationType
{
"type": "object",
"title": "chargeModelConfiguration",
"properties": {
"formula": {
"type": "string",
"description": "The pricing formula to calculate actual rating amount for each usage record.\n\nThis field is only available for the usage-based charges that use the Multi-Attribute Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
},
"customFieldPerUnitRate": {
"type": "string",
"description": "The custom field that carries the per-unit rate for each usage record. For example, `perUnitAmount__c`.\n \nThis field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
},
"customFieldTotalAmount": {
"type": "string",
"description": "The custom field that carries the total amount to charge for a usage record. For example, `totalAmount__c`. \n \nThis field is only available for the usage-based charges that use the Pre-Rated Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
}
},
"description": "Container for charge model configuration data.\n\n**Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. These charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
}
ChargeModelDataOverride
{
"type": "object",
"title": "chargeModelData",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeTier"
},
"description": "List of cumulative pricing tiers in the charge.\n\n**Note**: When you override the tiers of a usage-based charge using High Water Mark Pricing charge model, you have to provide all of the tiers, including the ones you do not want to change. The new tiers will completely override the previous ones. The High Water Mark Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
},
"quantity": {
"type": "number",
"minimum": 0,
"description": "Number of units purchased. This field is used if the Multi-Attribute Pricing formula uses the `quantity()` function.\n\nThis field is only available for one-time and recurring charges that use the Multi-Attribute Pricing charge model.\n"
},
"chargeModelConfiguration": {
"type": "object",
"properties": {
"formula": {
"type": "string",
"description": "The pricing formula to calculate actual rating amount.\n\nThis field is only available for charges that use the Multi-Attribute Pricing charge model.\n"
},
"customFieldPerUnitRate": {
"type": "string",
"description": "The custom field that carries the per-unit rate for each usage record. For example, `perUnitAmount__c`.\n\nThis field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
},
"customFieldTotalAmount": {
"type": "string",
"description": "The custom field that carries the total amount to charge for a usage record. For example, `totalAmount__c`. \n\nThis field is only available for the usage-based charges that use the Pre-Rated Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
}
}
}
},
"description": "Container for charge model configuration data.\n\n**Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
}
ChargeOverride
{
"type": "object",
"title": "charge",
"required": [
"productRateplanChargeId"
],
"properties": {
"name": {
"type": "string",
"description": "The name of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"billing": {
"type": "object",
"properties": {
"billCycleDay": {
"type": "integer",
"maximum": 31,
"minimum": 0,
"description": "Day of the month that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofMonth`.\n"
},
"billCycleType": {
"enum": [
"DefaultFromCustomer",
"SpecificDayofMonth",
"SubscriptionStartDay",
"ChargeTriggerDay",
"SpecificDayofWeek"
],
"type": "string",
"description": "Specifies how Zuora determines the day that each billing period begins on.\n\n * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.\n * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.\n * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.\n * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.\n * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.\n"
},
"billingPeriod": {
"enum": [
"Month",
"Quarter",
"Semi_Annual",
"Annual",
"Eighteen_Months",
"Two_Years",
"Three_Years",
"Five_Years",
"Specific_Months",
"Subscription_Term",
"Week",
"Specific_Weeks",
"Specific_Days"
],
"type": "string",
"description": "Billing frequency of the charge. The value of this field controls the duration of each billing period.\n\nIf the value of this field is `Specific_Days`, `Specific_Months` or `Specific_Weeks`, use the `specificBillingPeriod` field to specify the duration of each billing period.\n"
},
"billingTiming": {
"enum": [
"IN_ADVANCE",
"IN_ARREARS"
],
"type": "string",
"description": "Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).\n"
},
"weeklyBillCycleDay": {
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string",
"description": "Day of the week that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofWeek`.\n"
},
"specificBillingPeriod": {
"type": "integer",
"description": "Duration of each billing period in months or weeks, depending on the value of the `billingPeriod` field. Only applicable if the value of the `billingPeriod` field is `Specific_Months` or `Specific_Weeks`.\n"
},
"billingPeriodAlignment": {
"enum": [
"AlignToCharge",
"AlignToSubscriptionStart",
"AlignToTermStart"
],
"type": "string",
"description": "Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges.\n\n* `AlignToCharge` - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active.\n* `AlignToSubscriptionStart` - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription.\n* `AlignToTermStart` - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term.\n\nSee the `billCycleType` field for information about how Zuora determines the billing day.\n"
}
},
"description": "Billing information about the charge.\n"
},
"endDate": {
"$ref": "#/components/schemas/EndConditions"
},
"pricing": {
"type": "object",
"properties": {
"discount": {
"$ref": "#/components/schemas/DiscountPricingOverride"
},
"usageTiered": {
"$ref": "#/components/schemas/UsageTieredPricingOverride"
},
"usageVolume": {
"$ref": "#/components/schemas/UsageVolumePricingOverride"
},
"usageFlatFee": {
"$ref": "#/components/schemas/UsageFlatFeePricingOverride"
},
"usageOverage": {
"$ref": "#/components/schemas/UsageOveragePricingOverride"
},
"usagePerUnit": {
"$ref": "#/components/schemas/UsagePerUnitPricingOverride"
},
"oneTimeTiered": {
"$ref": "#/components/schemas/OneTimeTieredPricingOverride"
},
"oneTimeVolume": {
"$ref": "#/components/schemas/OneTimeVolumePricingOverride"
},
"oneTimeFlatFee": {
"$ref": "#/components/schemas/OneTimeFlatFeePricingOverride"
},
"oneTimePerUnit": {
"$ref": "#/components/schemas/OneTimePerUnitPricingOverride"
},
"chargeModelData": {
"$ref": "#/components/schemas/ChargeModelDataOverride"
},
"recurringTiered": {
"$ref": "#/components/schemas/RecurringTieredPricingOverride"
},
"recurringVolume": {
"$ref": "#/components/schemas/RecurringVolumePricingOverride"
},
"recurringFlatFee": {
"$ref": "#/components/schemas/RecurringFlatFeePricingOverride"
},
"recurringPerUnit": {
"$ref": "#/components/schemas/RecurringPerUnitPricingOverride"
},
"recurringDelivery": {
"$ref": "#/components/schemas/RecurringDeliveryPricingOverride"
},
"usageTieredWithOverage": {
"$ref": "#/components/schemas/UsageTieredWithOveragePricingOverride"
}
},
"description": "Pricing information about the charge.\n"
},
"taxCode": {
"type": "string",
"description": "The taxCode of a standalone charge.\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"taxMode": {
"type": "string",
"description": "The taxMode of a standalone charge. \n\nValues:\n* `TaxExclusive`\n* `TaxInclusive`\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"pobPolicy": {
"type": "string",
"description": "The pobPolicy of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"startDate": {
"$ref": "#/components/schemas/TriggerParams"
},
"chargeType": {
"type": "string",
"description": "The chargeType of a standalone charge.\n\n\nSupported charge types:\n\n* `OneTime`\n\n* `Recurring`\n\n* `Usage`\n\n\n**Note:** This field is available when the <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\"\ntarget=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"isRollover": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe value is either \"True\" or \"False\". It determines whether the rollover fields are needed.\n"
},
"isUnbilled": {
"type": "boolean",
"description": "This field is used to dictate how to perform the accounting during revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"revRecCode": {
"type": "string",
"maxLength": 70,
"description": "Revenue Recognition Code\n"
},
"chargeModel": {
"type": "string",
"description": "The chargeModel of a standalone charge.\n\n\nSupported charge models:\n\n* `FlatFee`\n\n* `PerUnit`\n\n* `Volume`\n\n* `Tiered`\n\n* `DiscountFixedAmount`\n\n* `DiscountPercentage`\n\n\n**Note:** This field is available when the <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\"\ntarget=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"description": {
"type": "string",
"maxLength": 500,
"description": "Description of the charge.\n"
},
"productLine": {
"type": "string",
"description": "The productLine of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"uniqueToken": {
"type": "string",
"maxLength": 50,
"description": "Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.\n"
},
"chargeNumber": {
"type": "string",
"maxLength": 50,
"description": "Charge number of the charge. For example, C-00000307.\n\nIf you do not set this field, Zuora will generate the charge number.\n"
},
"customFields": {
"$ref": "#/components/schemas/RatePlanChargeObjectCustomFields"
},
"drawdownRate": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).\n"
},
"productClass": {
"type": "string",
"description": "The productClass of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"productFamily": {
"type": "string",
"description": "The productFamily of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"rolloverApply": {
"enum": [
"ApplyFirst",
"ApplyLast"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the priority of rollover, which is either first or last.\n"
},
"prepaidQuantity": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).\n"
},
"productCategory": {
"type": "string",
"description": "The productCategory of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"rolloverPeriods": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the number of rollover periods, it is restricted to 3.\n"
},
"validityPeriodType": {
"enum": [
"SUBSCRIPTION_TERM",
"ANNUAL",
"SEMI_ANNUAL",
"QUARTER",
"MONTH"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"isAllocationEligible": {
"type": "boolean",
"description": "This field is used to identify if the charge segment is allocation eligible in revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"rolloverPeriodLength": {
"type": "integer",
"default": null,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period length of the rollover fund.\n"
},
"revRecTriggerCondition": {
"enum": [
"Contract Effective Date",
"Service Activation Date",
"Customer Acceptance Date"
],
"type": "string",
"description": "Specifies the revenue recognition trigger condition.\n\n * `Contract Effective Date` \n * `Service Activation Date`\n * `Customer Acceptance Date`\n"
},
"productRateplanChargeId": {
"type": "string",
"description": "Internal identifier of the product rate plan charge that the charge is based on.\n"
},
"revenueRecognitionTiming": {
"enum": [
"Upon Billing Document Posting Date",
"Upon Order Activation Date"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue recognition timing.\n\nPredefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"revenueAmortizationMethod": {
"enum": [
"Immediate",
"Ratable Using Start And End Dates"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue amortization method.\n\nPredefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "Specifies the revenue recognition rule, such as `Recognize upon invoicing` or `Recognize daily over time`.\n"
},
"contractAssetAccountingCode": {
"type": "string",
"description": "The contractAssetAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"productRatePlanChargeNumber": {
"type": "string",
"description": "Number of a product rate-plan charge for this subscription.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The deferredRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> and <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a> features are enabled.\n"
},
"accountReceivableAccountingCode": {
"type": "string",
"description": "The accountReceivableAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a>, <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a>, and <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Get_started_with_Invoice_Settlement/AA_Overview_of_Invoice_Settlement\" target=\"_blank\">Invoice Settlement</a> features are enabled.\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The adjustmentRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The contractLiabilityAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The recognizedRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> and <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a> features are enabled.\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The adjustmentLiabilityAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"unBilledReceivablesAccountingCode": {
"type": "string",
"description": "The unBilledReceivablesAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The contractRecognizedRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\nIf both the following features in <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing\" target=\"_blank\">Advanced Consumption Billing</a> are enabled in your tenant, you must ensure the `excludeItemBillingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the `excludeItemBookingFromRevenueAccounting` field in an Create Subscription or Add Product order action is set to `false`, you must also set the `excludeItemBillingFromRevenueAccounting` field in this order action to `false`.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charges from revenue accounting.\n\nIf both the following features in <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing\" target=\"_blank\">Advanced Consumption Billing</a> are enabled in your tenant, you must ensure the `excludeItemBookingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
}
},
"description": "Charge associated with a rate plan.\n"
}
ChargePreviewMetrics
{
"type": "object",
"properties": {
"tax": {
"type": "object",
"properties": {
"regular": {
"type": "number"
},
"discount": {
"type": "number",
"description": "Total tax amount of all discount charges which are applied to one specific recurring charge. This value is calculated from the rating results for the latest subscription version in the order."
},
"regularDelta": {
"type": "number",
"description": "Delta tax value between the base and the latest subscription version in the order."
},
"discountDelta": {
"type": "number",
"description": "Delta discount TAX value between the base and the latest subscription version in the order for the specific recurring charge."
}
}
},
"tcb": {
"type": "object",
"properties": {
"regular": {
"type": "number"
},
"discount": {
"type": "number",
"description": "Total contract billing amount of all discount charges which are applied to one specific recurring charge. This value is calculated from the rating results for the latest subscription version in the order."
},
"regularDelta": {
"type": "number",
"description": "Delta TCB value between the base and the latest subscription version in the order."
},
"discountDelta": {
"type": "number",
"description": "Delta discount TCB value between the base and the latest subscription version for specific recurring charge in the order."
}
}
},
"tcv": {
"type": "object",
"properties": {
"regular": {
"type": "number"
},
"discount": {
"type": "number",
"description": "Always equals to discountTcb."
},
"regularDelta": {
"type": "number"
},
"discountDelta": {
"type": "number",
"description": "Always equals to delta discountTcb."
}
}
},
"cmrr": {
"type": "object",
"properties": {
"regular": {
"type": "number"
},
"discount": {
"type": "number",
"description": "Total discountCmrr of all discount charges which are applied to one specific recurring charge. This value is calculated from the rating results for the latest subscription version in the order. Only selects the applied discount charge when its endDateCondition is \"Subscription_End\"."
},
"regularDelta": {
"type": "number"
},
"discountDelta": {
"type": "number",
"description": "Delta discountCmrr value between the order base and the latest subscription version."
}
}
},
"chargeNumber": {
"type": "string"
},
"originRatePlanId": {
"type": "string"
},
"productRatePlanId": {
"type": "string"
},
"productRatePlanChargeId": {
"type": "string"
},
"subscriptionRatePlanNumber": {
"type": "string",
"description": "Number of a subscription rate plan for this subscription.\n"
}
}
}
ChargeTier
{
"type": "object",
"title": "chargeTier",
"required": [
"tier",
"startingUnit",
"price",
"priceFormat"
],
"properties": {
"tier": {
"type": "integer",
"minimum": 1,
"description": "Index of the tier in the charge.\n"
},
"price": {
"type": "number",
"description": "Price or per-unit price of the tier, depending on the value of the `priceFormat` field.\n"
},
"endingUnit": {
"type": "number",
"description": "Limit on the number of units for which the tier is effective.\n"
},
"priceFormat": {
"enum": [
"FlatFee",
"PerUnit"
],
"type": "string",
"description": "Specifies whether the tier has a fixed price or a per-unit price.\n"
},
"startingUnit": {
"type": "number",
"description": "Number of units at which the tier becomes effective.\n"
}
}
}
ChargeUpdate
{
"type": "object",
"properties": {
"billing": {
"$ref": "#/components/schemas/BillingUpdate"
},
"pricing": {
"$ref": "#/components/schemas/PricingUpdate"
},
"description": {
"type": "string"
},
"uniqueToken": {
"type": "string",
"description": "description: |\n A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions.\n"
},
"chargeNumber": {
"type": "string",
"description": "The number of the charge to be updated. The value of this field is inherited from the `subscriptions` > `orderActions` > `addProduct` > `chargeOverrides` > `chargeNumber` field. \n"
},
"customFields": {
"$ref": "#/components/schemas/RatePlanChargeObjectCustomFields"
},
"effectiveDate": {
"$ref": "#/components/schemas/TriggerParams"
}
},
"description": "The JSON object containing the information for a charge update in the 'UpdateProduct' type order action.",
"x-konfig-properties": {
"pricing": {
"description": "Pricing information about the charge.\n"
}
}
}
ChildrenSettingValueRequest
{
"type": "object",
"title": "childSettingsRequest",
"properties": {
"id": {
"type": "string",
"description": "The id of the request. You can set it to any string. It must be unique within the whole batch.\n"
},
"url": {
"type": "string",
"description": "The relative URL of the setting. It is the same as in the `pathPattern` field in the response body of [Listing all settings](https://developer.zuora.com/api-references/api/operation/GET_ListAllSettings). For example, `/billing-rules`.\n"
},
"body": {
"$ref": "#/components/schemas/BodyInSettingValueRequest"
},
"method": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"TRACE"
],
"type": "string",
"description": "One of the HTTP methods supported by the setting endpoint, for example, GET,PUT,POST or DELETE.\n"
}
}
}
CommonOQErrorResponse
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "The error code.\n"
},
"message": {
"type": "string",
"description": "The error message.\n"
}
}
}
CommonResponse
{
"type": "object",
"properties": {
"reasons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The error code of response.\n"
},
"message": {
"type": "string",
"description": "The detail information of the error response\n"
}
}
}
},
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded.\n"
},
"processId": {
"type": "string",
"description": "The ID of the process that handles the operation.\n"
},
"requestId": {
"type": "string",
"format": "uuid",
"maxLength": 36,
"minLength": 36,
"description": "Unique identifier of the request.\n"
}
}
}
CompareSchemaInfoResponse
{
"type": "object",
"title": "CompareSchemaInfoResponse",
"properties": {
"metaData": {
"$ref": "#/components/schemas/JsonNode"
},
"settings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompareSchemaKeyValue"
}
},
"workflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompareSchemaKeyValue"
}
},
"customFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompareSchemaKeyValue"
}
},
"customObjects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompareSchemaKeyValue"
}
},
"notifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompareSchemaKeyValue"
}
},
"productCatalog": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompareSchemaKeyValue"
}
},
"dataAccessControl": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompareSchemaKeyValue"
}
}
},
"description": "When Tenant's Compare API returns a result, this object is used to send the response to UI."
}
CompareSchemaKeyValue
{
"type": "object",
"title": "CompareSchemaKeyValue",
"properties": {
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MigrationComponentContent"
},
"description": "Provides the total reponse of the components."
},
"difference": {
"type": "object",
"description": "Returns the different components list.",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"segregationKeys": {
"type": "array",
"items": {
"type": "string"
},
"description": "Provides separation of components."
}
},
"description": "When a comparison is made between a source and target tenant, it sends a response to the user interface."
}
ConfigTemplateErrorResponse
{
"type": "object",
"example": {
"reasons": [
{
"code": "ObjectNotFound",
"message": "Configuration Templates does not exist."
}
]
},
"properties": {
"reasons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The error code of response.\n"
},
"message": {
"type": "string",
"description": "A detailed description of the error response."
}
}
}
}
}
}
ConfigurationTemplateContent
{
"type": "object",
"title": "ConfigurationTemplateContent",
"properties": {
"id": {
"type": "string",
"description": "Id of Each component."
},
"key": {
"type": "string",
"description": "Key value of fields inside component."
},
"url": {
"type": "string",
"description": "Metadata is retrieved from this URL."
},
"error": {
"type": "string",
"description": "Error Information."
},
"method": {
"type": "string",
"description": "Http method which is used to retrieve the particular component."
},
"result": {
"type": "string",
"description": "Contains the response of details fetched regarding selected component."
},
"payload": {
"$ref": "#/components/schemas/JsonNode"
},
"templateId": {
"type": "string",
"description": "Id of the Template."
},
"componentType": {
"type": "string",
"description": "Type of Component."
},
"segregationKey": {
"type": "string",
"description": "Gives the difference between components and sub components."
}
},
"description": "It contains information about template schemas with segregation keys."
}
ContactCustomFields
{
"type": "object",
"additionalProperties": {
"description": "Custom fields of the Contact object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n\n \n \n"
}
}
ContactInfo
{
"allOf": [
{
"type": "object",
"required": [
"firstName",
"lastName"
],
"properties": {
"fax": {
"type": "string",
"maxLength": 40,
"description": "Fax number of the contact.\n"
},
"city": {
"type": "string",
"maxLength": 40,
"description": "City of the contact's address.\n"
},
"state": {
"type": "string",
"maxLength": 40,
"description": "State or province of the contact's address.\n"
},
"county": {
"type": "string",
"maxLength": 32,
"description": "County of the contact's address.\n"
},
"country": {
"type": "string",
"maxLength": 64,
"description": "Country; must be a valid country name or abbreviation. If using [Zuora Tax](https://knowledgecenter.zuora.com/Zuora_Billing/Taxes/A_Zuora_Tax), you must specify a country in the bill-to contact to calculate tax.\n"
},
"address1": {
"type": "string",
"maxLength": 255,
"description": "First line of the contact's address. This is often a street address or a business name.\n"
},
"address2": {
"type": "string",
"maxLength": 255,
"description": "Second line of the contact's address.\n"
},
"lastName": {
"type": "string",
"maxLength": 100,
"description": ""
},
"nickname": {
"type": "string",
"maxLength": 100,
"description": "Nickname of the contact.\n"
},
"firstName": {
"type": "string",
"maxLength": 100,
"description": "First name of the contact.\n"
},
"homePhone": {
"type": "string",
"maxLength": 40,
"description": "Home phone number of the contact.\n"
},
"taxRegion": {
"type": "string",
"maxLength": 32,
"description": "Region defined in your taxation rules. Only applicable if you use Zuora Tax.\n"
},
"workEmail": {
"type": "string",
"format": "email",
"maxLength": 80,
"description": "Business email address of the contact.\n"
},
"workPhone": {
"type": "string",
"maxLength": 40,
"description": "Business phone number of the contact.\n"
},
"otherPhone": {
"type": "string",
"maxLength": 40,
"description": "Additional phone number of the contact. Use the `otherPhoneType` field to specify the type of phone number.\n"
},
"postalCode": {
"type": "string",
"maxLength": 20,
"description": "ZIP code or other postal code of the contact's address.\n"
},
"mobilePhone": {
"type": "string",
"maxLength": 40,
"description": "Mobile phone number of the contact.\n"
},
"customFields": {
"$ref": "#/components/schemas/CustomFields"
},
"personalEmail": {
"type": "string",
"format": "email",
"maxLength": 80,
"description": "Personal email address of the contact.\n"
},
"otherPhoneType": {
"enum": [
"Work",
"Mobile",
"Home",
"Other"
],
"type": "string",
"description": "Specifies the type of phone number in the `otherPhone` field.\n"
},
"contactDescription": {
"type": "string",
"maxLength": 100,
"description": "A description for the contact.\n"
}
},
"description": "Contact details associated with an account.\n"
},
{}
]
}
ContactObjectCustomFields
{
"type": "object",
"title": "contactFieldsCustom",
"description": "Container for custom fields of a Contact object.\n",
"additionalProperties": {
"description": "Custom fields of the Contact object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
ContactResponse
{
"allOf": [
{
"type": "object",
"properties": {
"fax": {
"type": "string",
"maxLength": 40,
"description": "The contact's fax number. \n"
},
"city": {
"type": "string",
"maxLength": 40,
"description": "The city of the contact's address.\n"
},
"state": {
"type": "string",
"maxLength": 40,
"description": "The state or province of the contact's address.\n"
},
"county": {
"type": "string",
"maxLength": 32,
"description": "The county. May optionally be used by Zuora Tax to calculate county tax.\n"
},
"country": {
"type": "string",
"maxLength": 64,
"description": "The country of the contact's address.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"zipCode": {
"type": "string",
"maxLength": 20,
"description": "The zip code for the contact's address.\n"
},
"address1": {
"type": "string",
"maxLength": 255,
"description": "The first line of the contact's address, which is often a street address or business name.\n"
},
"address2": {
"type": "string",
"maxLength": 255,
"description": "The second line of the contact's address.\n"
},
"lastName": {
"type": "string",
"maxLength": 100,
"description": "The contact's last name.\n"
},
"nickname": {
"type": "string",
"maxLength": 100,
"description": "A nickname for the contact.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with the contact.\n"
},
"firstName": {
"type": "string",
"maxLength": 100,
"description": "The contact's first name.\n"
},
"homePhone": {
"type": "string",
"maxLength": 40,
"description": "The contact's home phone number.\n"
},
"taxRegion": {
"type": "string",
"maxLength": 32,
"description": "If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n"
},
"workEmail": {
"type": "string",
"maxLength": 74,
"description": "The contact's business email address.\n"
},
"workPhone": {
"type": "string",
"maxLength": 40,
"description": "The contact's business phone number.\n"
},
"otherPhone": {
"type": "string",
"maxLength": 40,
"description": "An additional phone number for the contact.\n"
},
"mobilePhone": {
"type": "string",
"maxLength": 100,
"description": "The mobile phone number of the contact.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account associated with the contact.\n"
},
"personalEmail": {
"type": "string",
"maxLength": 74,
"description": "The contact's personal email address.\n"
},
"otherPhoneType": {
"enum": [
"Work",
"Mobile",
"Home",
"Other"
],
"type": "string",
"description": "The type of the additional phone number.\n"
},
"contactDescription": {
"type": "string",
"maxLength": 100,
"description": "A description for the contact.\n"
}
}
},
{
"$ref": "#/components/schemas/ContactObjectCustomFields"
}
]
}
ContactSnapshotObjectCustomFields
{
"type": "object",
"title": "contactSnapshotFieldsCustom",
"description": "Container for custom fields of a Contact Snapshot object.\n",
"additionalProperties": {
"description": "Custom fields of the Contact Snapshot object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Custom_fields/Manage_custom_fields\" target=\"_blank\">Manage custom fields</a>.\n"
}
}
CreateChangePlan
{
"type": "object",
"title": "createChangePlan",
"required": [
"newProductRatePlan"
],
"properties": {
"subType": {
"enum": [
"Upgrade",
"Downgrade",
"Crossgrade",
"PlanChanged"
],
"type": "string",
"description": "Use this field to choose the sub type for your change plan order action.\n\nHowever, if you do not set this field, the field will be automatically generated by the system according to the following rules:\n\nWhen the old and new rate plans are within the same Grading catalog group:\n* If the grade of new plan is greater than that of the old plan, this is an \"Upgrade\".\n* If the grade of new plan is less than that of the old plan, this is a \"Downgrade\".\n* If the grade of new plan equals that of the old plan, this is a \"Crossgrade\".\n\nWhen the old and new rate plans are not in the same Grading catalog group, or either has no group, this is \"PlanChanged\".\n"
},
"resetBcd": {
"type": "boolean",
"default": false,
"description": "If resetBcd is true then reset the Account BCD to the effective date; if it is false keep the original BCD.\n"
},
"ratePlanId": {
"type": "string",
"description": "ID of the rate plan to remove. This can be the latest version or any history version of ID. Note that the removal of a rate plan through the Change Plan order action supports the function of <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/Order_actions_tutorials/E2_Remove_rate_plan_on_subscription_before_future-dated_removals\" target=\"_blank\">removal before future-dated removals</a>, as in a Remove Product order action.\n"
},
"effectivePolicy": {
"enum": [
"EffectiveImmediately",
"EffectiveEndOfBillingPeriod",
"SpecificDate"
],
"type": "string",
"description": "The default value for the `effectivePolicy` field is as follows:\n * If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default.\n * If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default.\n * Otherwise, the effective policy is `SpecificDate` by default.\n\n**Notes**: \n * When setting this field to `EffectiveEndOfBillingPeriod`, you cannot set the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/W_Subscription_and_Amendment_Dates#Billing_Trigger_Dates\" target=\"_blank\">billing trigger dates</a> for the subscription as the system will automatically set the trigger dates to the end of billing period, and you cannot set the following billing trigger date settings to `Yes`:\n * <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Default_Subscription_and_Order_Settings#Require_Customer_Acceptance_of_Orders.3F\" target=\"_blank\">Require Customer Acceptance of Orders?</a>\n * <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Default_Subscription_and_Order_Settings#Require_Service_Activation_of_Orders.3F\" target=\"_blank\">Require Service Activation of Orders?</a>\n \n * When setting this field to `SpecificDate`, you must also set the contract effective date in the `triggerDates` field as follows:\n * Set the `name` field as `ContractEffective`\n * Specify a date for the `triggerDate` field\n"
},
"productRatePlanId": {
"type": "string",
"description": "ID of the product rate plan that the removed rate plan is based on.\n"
},
"newProductRatePlan": {
"$ref": "#/components/schemas/CreateOrderChangePlanRatePlanOverride"
},
"externalCatalogPlanId": {
"type": "string",
"description": "An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to remove the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.\n\n**Note:** Please provide only one of `externalCatalogPlanId`, `ratePlanId` or `productRatePlanId`. If more than 1 field is provided then the request would fail.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription.\n"
},
"subscriptionRatePlanNumber": {
"type": "string",
"description": "Number of a rate plan for this subscription.\n"
}
},
"description": "Information about an order action of type `ChangePlan`. \n\nUse the change plan type of order action to replace the existing rate plans in a subscription with other rate plans.\n\n**Note**: The change plan type of order action is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.\n\nIf you want to create a pending order through the \"change plan\" order action, and if the charge's trigger condition is `Specific Date`, you must set a charge number in the `chargeNumber` field for the \"change plan\" order action. In this case, if you do not set it, Zuora will not generate the charge number for you.\n\nSee more information about pending orders in <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/Pending_orders_and_subscriptions\" target=\"_blank\">Pending orders and subscriptions</a>.\n"
}
CreateEInvoiceFileTemplateRequest
{
"allOf": [
{
"type": "object",
"required": [
"country",
"documentType",
"provider",
"content",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the e-invoice file template.\n"
},
"content": {
"type": "string",
"description": "The content of the e-invoice file template, which must be encoded in Base64 format.\n"
},
"country": {
"type": "string",
"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 <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions\" target=\"_blank\">View countries or regions</a>.\n"
},
"provider": {
"enum": [
"Sovos"
],
"type": "string",
"description": "The name of an e-invoicing service provider that assists in generating e-invoice files.\n"
},
"documentType": {
"enum": [
"Invoice",
"CreditMemo",
"DebitMemo"
],
"type": "string",
"description": "The type of billing documents, which the e-invoice file template is intended for.\n"
}
}
}
],
"example": {
"name": "Sovos e-invoice service",
"content": "base64 encoded content",
"country": "IN",
"provider": "Sovos",
"documentType": "Invoice"
}
}
CreateEInvoicingBusinessRegionRequest
{
"allOf": [
{
"type": "object",
"required": [
"country",
"businessName"
],
"properties": {
"city": {
"type": "string",
"description": "The the name of the city where the business is located.\n"
},
"email": {
"type": "string",
"description": "The email address of the Seller contact to receive e-invoicing data.\n"
},
"state": {
"type": "string",
"description": "The name of the state or province where the business is located.\n"
},
"country": {
"type": "string",
"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 <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions\" target=\"_blank\">View countries or regions</a>.\n"
},
"tradeName": {
"type": "string",
"maxLength": 100,
"description": "The name that the Seller is known as, other than the legal business name.\n"
},
"endpointId": {
"type": "string",
"description": "The Seller's electronic address, to which the application-level response to the e-invoice file might be delivered.\n"
},
"postalCode": {
"type": "string",
"description": "The short code that can identify the business address.\n"
},
"contactName": {
"type": "string",
"maxLength": 255,
"description": "The name of the Seller contact to receive e-invoicing data.\n"
},
"phoneNumber": {
"type": "string",
"description": "The business phone number of the Seller contact to receive e-invoicing data.\n"
},
"addressLine1": {
"type": "string",
"description": "The first line of the Seller’s address, which is often a street address or business name.\n"
},
"addressLine2": {
"type": "string",
"description": "The second line of the Seller’s address, which is often the name of a building.\n"
},
"businessName": {
"type": "string",
"maxLength": 255,
"description": "The full official name that the Seller is registered with the relevant legal authority.\n"
},
"businessNumber": {
"type": "string",
"description": "The specify the unique identifier number of the legal entity or person that you do business with.\n\nFor example, you must use a GSTIN for India and Tax Identification Number (TIN) for Saudi Arabia.\n"
},
"responseMapping": {
"type": "object",
"title": "responseMapping",
"description": "Container for e-invoicing response field mappings that map values from Sovos response data to fields on the EInvoiceData object in Zuora. Each response field mapping consists of a field name and a field path.\n\nNote that this field is applicable only to the Sovos service provider.\n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings\" target=\"_blank\">Configure e-invoicing response field mappings</a>.\n",
"additionalProperties": {
"type": "string",
"description": "The response field mapping consists of a key-value pair:\n\n* Field name: the name of the field on the EInvoiceData object (except for the `EInvoiceFile` field). <br>Zuora supports the following field names. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Supported_response_fields\" target=\"_blank\">Supported response fields</a>.\n * `AuthorizationCode`\n * `EInvoiceFile`\n * `QrCode`\n * `ReferenceNumber`\n * `Field1` to `Field10`\n\n* Field value: the path of an XML node in the e-invoicing response data from Sovos. The value of this field must be compliant with the <a href=\"https://www.w3schools.com/xml/xpath_intro.asp\" target=\"_blank\">XPath</a> syntax. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Field_path_format\" target=\"_blank\">Field path format</a>.\n"
}
},
"endpointSchemeId": {
"type": "string",
"description": "The identification scheme identifier of the Seller’s electronic address.\n"
},
"serviceProviderId": {
"type": "string",
"description": "The unique ID of the e-invoicing service provider that is associated to the business region.\n"
},
"taxRegisterNumber": {
"type": "string",
"description": "The Seller's VAT identifier (also known as Seller VAT identification number) or the local identification (defined by the Seller’s address) of the Seller for tax purposes, or a reference that enables the Seller to state the registered tax status.\n"
},
"businessNumberSchemaId": {
"type": "string",
"description": "The identification scheme identifier that an official registrar issues to identify the Seller as a legal entity or person.\n"
},
"digitalSignatureEnable": {
"type": "boolean",
"default": false,
"description": "Whether the e-invoicing service provider signs PDF files for billing documents.\n"
},
"digitalSignatureBoxPosX": {
"type": "number",
"minimum": 0,
"description": "The X-coordinate to determine where the digital signature box is displayed on PDF files for billing documents.\n"
},
"digitalSignatureBoxPosY": {
"type": "number",
"minimum": 0,
"description": "The Y-coordinate to determine where the digital signature box is displayed on PDF files for billing documents. \n"
},
"digitalSignatureBoxEnable": {
"type": "boolean",
"default": false,
"description": "Whether the digital signature box is displayed on PDF files for billing documents.\n"
}
}
}
],
"example": {
"city": "Tokyo",
"email": null,
"state": null,
"country": "JP",
"tradeName": "Zuora",
"endpointId": "8992",
"postalCode": "368779",
"contactName": null,
"phoneNumber": null,
"addressLine1": null,
"addressLine2": null,
"businessName": "legal business name",
"businessNumber": "20002039",
"endpointSchemeId": "88",
"serviceProviderId": "4028948972a2bf990172bc9b27724ddc",
"taxRegisterNumber": "TAX393999",
"businessNumberSchemaId": "88"
}
}
CreateEInvoicingServiceProviderRequest
{
"allOf": [
{
"type": "object",
"required": [
"name",
"provider"
],
"properties": {
"name": {
"type": "string",
"maxLength": 100,
"description": "The name of the e-invoicing service provider.\n"
},
"test": {
"type": "boolean",
"description": "Whether the e-invoicing service provider's configuration is intended for testing. \n\n- If you set this field to `true`, requests are directed to the testing integration endpoints.\n- If you set this field to `false`, requests are directed to the production integration endpoints.\n"
},
"apiKey": {
"type": "string",
"description": "The API key is used to authenticate the e-invoicing service provider's requests. This field is required for configuring Sovos as the service provider.\n"
},
"provider": {
"enum": [
"Sovos",
"PEPPOL"
],
"type": "string",
"description": "The name of the e-invoicing service provider that can help you generate e-invoice files for billing documents.\n"
},
"secretKey": {
"type": "string",
"description": "The secret key is used to authenticate the e-invoicing service provider's requests. This field is required for configuring Sovos as the service provider.\n"
},
"clientCertificate": {
"type": "string",
"format": "byte",
"description": "The client certificate is used to authenticate the e-invoicing service provider's requests, which should be in base64 encoded format. This field is required for configuring Sovos as the service provider.\n"
},
"companyIdentifier": {
"type": "string",
"description": "The identifier of the company used to create a sender system ID, which serves to identify the system where the transactions are sent.\n"
},
"clientCertificateType": {
"type": "string",
"default": "PKCS12",
"description": "The client certificate type is used to specify the type of the client certificate. This field is required for configuring Sovos as the service provider.\n"
},
"clientCertificatePassword": {
"type": "string",
"format": "password",
"description": "The client certificate password is the password to protect the client certificate. This field is required for configuring Sovos as the service provider.\n"
}
}
}
],
"example": {
"name": "Sovos e-invoice service",
"test": false,
"apiKey": "ApiKeySample",
"provider": "Sovos",
"secretKey": "SecretKey",
"clientCertificate": "U3dhZ2dlciByb2Nrcw==",
"companyIdentifier": "CompanySample1",
"clientCertificateType": "PKCS12",
"clientCertificatePassword": "ClientCertificatePassword"
}
}
CreateOrUpdateEmailTemplatesResponse
{
"type": "object",
"example": {
"reasons": []
},
"properties": {
"reasons": {
"type": "array",
"items": {
"type": "string"
},
"description": "Returns an empty array if the request succeeds.\n"
}
}
}
CreateOrderChangePlanRatePlanOverride
{
"type": "object",
"title": "ratePlan",
"properties": {
"uniqueToken": {
"type": "string",
"maxLength": 50,
"description": "Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrdersRatePlanObjectCustomFields"
},
"ratePlanName": {
"type": "string",
"description": "Name of the standalone rate plan.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"chargeOverrides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChangePlanChargeOverride"
},
"description": "List of charges associated with the rate plan.\n"
},
"productRatePlanId": {
"type": "string",
"description": "Internal identifier of the product rate plan that the rate plan is based on.\n"
},
"externalCatalogPlanId": {
"type": "string",
"description": "An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.\n\n**Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.\n"
},
"isFromExternalCatalog": {
"type": "boolean",
"description": "Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription.\n"
},
"externallyManagedPlanId": {
"type": "string",
"description": "Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n"
},
"clearingExistingFeatures": {
"type": "boolean",
"description": "Specifies whether all features in the rate plan will be cleared.\n"
},
"subscriptionRatePlanNumber": {
"type": "string",
"maxLength": 50,
"description": "Number of a subscription rate plan for this subscription.\n"
},
"subscriptionProductFeatures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOrderRatePlanFeatureOverride"
},
"description": "List of features associated with the rate plan.\nThe system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:\n* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.\n* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.\n"
}
},
"description": "Information about the new product rate plan to add. \n"
}
CreateOrderChargeOverride
{
"type": "object",
"title": "charge",
"required": [
"productRatePlanChargeId"
],
"properties": {
"name": {
"type": "string",
"description": "The name of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"billing": {
"type": "object",
"properties": {
"billCycleDay": {
"type": "integer",
"maximum": 31,
"minimum": 0,
"description": "Day of the month that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofMonth`.\n"
},
"billCycleType": {
"enum": [
"DefaultFromCustomer",
"SpecificDayofMonth",
"SubscriptionStartDay",
"ChargeTriggerDay",
"SpecificDayofWeek"
],
"type": "string",
"description": "Specifies how Zuora determines the day that each billing period begins on.\n\n * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.\n * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.\n * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.\n * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.\n * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.\n"
},
"billingPeriod": {
"enum": [
"Month",
"Quarter",
"Semi_Annual",
"Annual",
"Eighteen_Months",
"Two_Years",
"Three_Years",
"Five_Years",
"Specific_Months",
"Subscription_Term",
"Week",
"Specific_Weeks",
"Specific_Days"
],
"type": "string",
"description": "Billing frequency of the charge. The value of this field controls the duration of each billing period.\n\nIf the value of this field is `Specific_Days`, `Specific_Months` or `Specific_Weeks`, use the `specificBillingPeriod` field to specify the duration of each billing period.\n"
},
"billingTiming": {
"enum": [
"IN_ADVANCE",
"IN_ARREARS"
],
"type": "string",
"description": "Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).\n"
},
"weeklyBillCycleDay": {
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string",
"description": "Day of the week that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofWeek`.\n"
},
"specificBillingPeriod": {
"type": "integer",
"description": "Duration of each billing period in months or weeks, depending on the value of the `billingPeriod` field. Only applicable if the value of the `billingPeriod` field is `Specific_Months` or `Specific_Weeks`.\n"
},
"billingPeriodAlignment": {
"enum": [
"AlignToCharge",
"AlignToSubscriptionStart",
"AlignToTermStart"
],
"type": "string",
"description": "Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges.\n\n* `AlignToCharge` - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active.\n* `AlignToSubscriptionStart` - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription.\n* `AlignToTermStart` - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term.\n\nSee the `billCycleType` field for information about how Zuora determines the billing day.\n"
}
},
"description": "Billing information about the charge.\n"
},
"endDate": {
"$ref": "#/components/schemas/EndConditions"
},
"pricing": {
"type": "object",
"properties": {
"discount": {
"$ref": "#/components/schemas/DiscountPricingOverride"
},
"usageTiered": {
"$ref": "#/components/schemas/UsageTieredPricingOverride"
},
"usageVolume": {
"$ref": "#/components/schemas/UsageVolumePricingOverride"
},
"usageFlatFee": {
"$ref": "#/components/schemas/UsageFlatFeePricingOverride"
},
"usageOverage": {
"$ref": "#/components/schemas/UsageOveragePricingOverride"
},
"usagePerUnit": {
"$ref": "#/components/schemas/UsagePerUnitPricingOverride"
},
"oneTimeTiered": {
"$ref": "#/components/schemas/OneTimeTieredPricingOverride"
},
"oneTimeVolume": {
"$ref": "#/components/schemas/OneTimeVolumePricingOverride"
},
"oneTimeFlatFee": {
"$ref": "#/components/schemas/OneTimeFlatFeePricingOverride"
},
"oneTimePerUnit": {
"$ref": "#/components/schemas/OneTimePerUnitPricingOverride"
},
"chargeModelData": {
"$ref": "#/components/schemas/ChargeModelDataOverride"
},
"recurringTiered": {
"$ref": "#/components/schemas/RecurringTieredPricingOverride"
},
"recurringVolume": {
"$ref": "#/components/schemas/RecurringVolumePricingOverride"
},
"recurringFlatFee": {
"$ref": "#/components/schemas/RecurringFlatFeePricingOverride"
},
"recurringPerUnit": {
"$ref": "#/components/schemas/RecurringPerUnitPricingOverride"
},
"recurringDeliveryBased": {
"$ref": "#/components/schemas/RecurringDeliveryPricingOverride"
},
"usageTieredWithOverage": {
"$ref": "#/components/schemas/UsageTieredWithOveragePricingOverride"
}
},
"description": "Pricing information about the charge.\n"
},
"taxCode": {
"type": "string",
"description": "The taxCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"taxMode": {
"type": "string",
"description": "The taxMode of a standalone charge. \n\nValues:\n* `TaxExclusive`\n* `TaxInclusive`\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"pobPolicy": {
"type": "string",
"description": "The pobPolicy of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"startDate": {
"$ref": "#/components/schemas/CreateOrderTriggerParams"
},
"chargeType": {
"type": "string",
"description": "The chargeType of a standalone charge.\n\n\nSupported charge types:\n\n* `OneTime`\n\n* `Recurring`\n\n* `Usage`\n\n**Note:** This field is available when the <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\"\ntarget=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"isRollover": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe value is either \"True\" or \"False\". It determines whether the rollover fields are needed.\n"
},
"isUnbilled": {
"type": "boolean",
"description": "This field is used to dictate how to perform the accounting during revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"revRecCode": {
"type": "string",
"maxLength": 70,
"description": "Revenue Recognition Code\n"
},
"chargeModel": {
"type": "string",
"description": "The chargeModel of a standalone charge.\n\n\nSupported charge models:\n\n* `FlatFee`\n\n* `PerUnit`\n\n* `Volume`\n\n* `Tiered`\n\n* `DiscountFixedAmount`\n\n* `DiscountPercentage`\n\n**Note:** This field is available when the <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\"\ntarget=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"description": {
"type": "string",
"maxLength": 500,
"description": "Description of the charge.\n"
},
"productLine": {
"type": "string",
"description": "The productLine of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"uniqueToken": {
"type": "string",
"maxLength": 50,
"description": "Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.\n"
},
"chargeNumber": {
"type": "string",
"maxLength": 50,
"description": "Charge number of the charge. For example, C-00000307.\n\nIf you do not set this field, Zuora will generate the charge number.\n"
},
"customFields": {
"$ref": "#/components/schemas/RatePlanChargeObjectCustomFields"
},
"drawdownRate": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).\n"
},
"productClass": {
"type": "string",
"description": "The productClass of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"productFamily": {
"type": "string",
"description": "The productFamily of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"rolloverApply": {
"enum": [
"ApplyFirst",
"ApplyLast"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the priority of rollover, which is either first or last.\n"
},
"prepaidQuantity": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).\n"
},
"productCategory": {
"type": "string",
"description": "The productCategory of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"rolloverPeriods": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the number of rollover periods, it is restricted to 3.\n"
},
"validityPeriodType": {
"enum": [
"SUBSCRIPTION_TERM",
"ANNUAL",
"SEMI_ANNUAL",
"QUARTER",
"MONTH"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"isAllocationEligible": {
"type": "boolean",
"description": "This field is used to identify if the charge segment is allocation eligible in revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"rolloverPeriodLength": {
"type": "integer",
"default": null,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period length of the rollover fund.\n"
},
"revRecTriggerCondition": {
"enum": [
"Contract Effective Date",
"Service Activation Date",
"Customer Acceptance Date"
],
"type": "string",
"description": "Specifies the revenue recognition trigger condition.\n\n * `Contract Effective Date` \n * `Service Activation Date`\n * `Customer Acceptance Date`\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "Internal identifier of the product rate plan charge that the charge is based on.\n"
},
"upsellOriginChargeNumber": {
"type": "string",
"description": "The identifier of the original upselling charge associated with the current charge.\n\nFor a termed subscription, you can now use the \"Create an order\" API operation to perform an Add Product order action to make a product quantity upsell for per unit recurring charges. The benefit is that the charge added by this approach will be automatically combined with the original existing charge for which you want to upsell when the subscription is renewed. The approach is as follows:\n* Use an Add Product order action to add a charge that is of the same charge type, charge model, and charge end date as the existing per unit recurring charge for which you want to make a quantity upsell.\n\n* In the preceding charge to add, use the `upsellOriginChargeNumber` field to specify the existing rate plan charge for which you want to make the quantity upsell.\n\nNote that a termed subscription with such upsell charges can not be changed to an evergreen subscription. \n\n**Note**: The Quantity Upsell 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. If you want to join this early adopter program, submit a request at [Zuora Global\n Support](https://support.zuora.com). \n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "Specifies the revenue recognition rule, such as `Recognize upon invoicing` or `Recognize daily over time`.\n"
},
"contractAssetAccountingCode": {
"type": "string",
"description": "The contractAssetAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"productRatePlanChargeNumber": {
"type": "string",
"description": "Number of a product rate-plan charge for this subscription.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The deferredRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> and <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a> features are enabled.\n"
},
"accountReceivableAccountingCode": {
"type": "string",
"description": "The accountReceivableAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a>, <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a>, and <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Get_started_with_Invoice_Settlement/AA_Overview_of_Invoice_Settlement\" target=\"_blank\">Invoice Settlement</a> features are enabled.\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The adjustmentRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The contractLiabilityAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The recognizedRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> and <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a> features are enabled.\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The adjustmentLiabilityAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"unBilledReceivablesAccountingCode": {
"type": "string",
"description": "The unBilledReceivablesAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The contractRecognizedRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\nIf both the following features in <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing\" target=\"_blank\">Advanced Consumption Billing</a> are enabled in your tenant, you must ensure the `excludeItemBillingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the `excludeItemBookingFromRevenueAccounting` field in a Create Subscription or Add Product order action is set to `false`, you must also set the `excludeItemBillingFromRevenueAccounting` field in this order action to `false`.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charges from revenue accounting.\n\nIf both the following features in <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing\" target=\"_blank\">Advanced Consumption Billing</a> are enabled in your tenant, you must ensure the `excludeItemBookingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
}
},
"description": "Charge associated with a rate plan.\n"
}
CreateOrderChargeUpdate
{
"type": "object",
"properties": {
"billing": {
"$ref": "#/components/schemas/BillingUpdate"
},
"pricing": {
"$ref": "#/components/schemas/CreateOrderPricingUpdate"
},
"description": {
"type": "string"
},
"uniqueToken": {
"type": "string",
"description": "A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions.\n"
},
"chargeNumber": {
"type": "string",
"description": "The number of the charge to be updated. The value of this field is inherited from the `subscriptions` > `orderActions` > `addProduct` > `chargeOverrides` > `chargeNumber` field.\n"
},
"customFields": {
"$ref": "#/components/schemas/RatePlanChargeObjectCustomFields"
},
"effectiveDate": {
"$ref": "#/components/schemas/CreateOrderUpdateProductTriggerParams"
},
"prepaidQuantity": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).\n"
}
},
"description": "The JSON object containing the information for a charge update in the 'UpdateProduct' type order action.\n",
"x-konfig-properties": {
"pricing": {
"description": "Pricing information about the charge.\n"
}
}
}
CreateOrderCreateSubscription
{
"type": "object",
"title": "createSubscription",
"properties": {
"notes": {
"type": "string",
"maxLength": 500,
"description": "Notes about the subscription. These notes are only visible to Zuora users.\n"
},
"terms": {
"type": "object",
"required": [
"initialTerm"
],
"properties": {
"autoRenew": {
"type": "boolean",
"description": "Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is `TERMED`.\n"
},
"initialTerm": {
"type": "object",
"required": [
"termType"
],
"properties": {
"period": {
"type": "integer",
"description": "Duration of the first term in months, years, days, or weeks, depending on the value of the `periodType` field. Only applicable if the value of the `termType` field is `TERMED`.\n"
},
"endDate": {
"type": "string",
"format": "date",
"description": "End date of the first term, in YYYY-MM-DD format.\n"
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN"
],
"type": "string",
"description": "Type of the first term. If the value of this field is `TERMED`, the first term has a predefined duration based on the value of the `period` field. If the value of this field is `EVERGREEN`, the first term does not have a predefined duration.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "Start date of the first term, in YYYY-MM-DD format.\n"
},
"periodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"description": "Unit of time that the first term is measured in. Only applicable if the value of the `termType` field is `TERMED`.\n"
}
},
"description": "Information about the first term of the subscription.\n"
},
"renewalTerms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RenewalTerm"
},
"description": "List of renewal terms of the subscription. Only applicable if the type of the first term is `TERMED` and the value of the `renewalSetting` field is `RENEW_WITH_SPECIFIC_TERM`.\n"
},
"renewalSetting": {
"enum": [
"RENEW_WITH_SPECIFIC_TERM",
"RENEW_TO_EVERGREEN"
],
"type": "string",
"description": "Specifies the type of the terms that follow the first term if the subscription is renewed. Only applicable if the type of the first term is `TERMED`.\n\n* `RENEW_WITH_SPECIFIC_TERM` - Each renewal term has a predefined duration. The first entry in `renewalTerms` specifies the duration of the second term of the subscription, the second entry in `renewalTerms` specifies the duration of the third term of the subscription, and so on. The last entry in `renewalTerms` specifies the ultimate duration of each renewal term.\n* `RENEW_TO_EVERGREEN` - The second term of the subscription does not have a predefined duration.\n"
}
},
"description": "Container for the terms and renewal settings of the subscription.\n"
},
"currency": {
"type": "string",
"maxLength": 3,
"description": "The code of currency that is used for this subscription. If the currency is not selected, the default currency from the account will be used.\n\nAll subscriptions in the same order must use the same currency. The currency for a subscription cannot be changed.\n\n**Note**: \n This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currencies</a> feature enabled.\n"
},
"paymentTerm": {
"type": "string",
"description": "The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceSeparately": {
"type": "boolean",
"description": "Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"maxLength": 255,
"description": "The number of the invoice group associated with the subscription.\n\nAfter enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"subscriptionNumber": {
"type": "string",
"maxLength": 100,
"description": "Subscription number of the subscription. For example, A-S00000001.\n\nIf you do not set this field, Zuora will generate the subscription number.\n"
},
"subscribeToRatePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOrderRatePlanOverride"
},
"description": "List of rate plans associated with the subscription.\n"
},
"newSubscriptionOwnerAccount": {
"$ref": "#/components/schemas/CreateOrderCreateSubscriptionNewSubscriptionOwnerAccount"
},
"subscriptionOwnerAccountNumber": {
"type": "string",
"maxLength": 70,
"description": "Account number of an existing account that will own the subscription. For example, A00000001.\n\nIf you do not set this field or the `newSubscriptionOwnerAccount` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `newSubscriptionOwnerAccount` field.\n"
}
},
"description": "Information about an order action of type `CreateSubscription`.\n"
}
CreateOrderCreateSubscriptionNewSubscriptionOwnerAccount
{
"allOf": [
{
"type": "object",
"required": [
"name",
"currency",
"billCycleDay",
"billToContact"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "Account name.\n"
},
"batch": {
"type": "string",
"description": "Name of the billing batch that the account belongs to. For example, Batch1.\n"
},
"crmId": {
"type": "string",
"maxLength": 100,
"description": "External identifier of the account in a CRM system.\n"
},
"notes": {
"type": "string",
"maxLength": 65535,
"description": "Notes about the account. These notes are only visible to Zuora users.\n"
},
"autoPay": {
"type": "boolean",
"description": "Specifies whether future payments are automatically billed when they are due.\n"
},
"taxInfo": {
"$ref": "#/components/schemas/TaxInfo"
},
"currency": {
"type": "string",
"description": "ISO 3-letter currency code (uppercase). For example, USD.\n"
},
"parentId": {
"type": "string",
"description": "Identifier of the parent customer account for this Account object. Use this field if you have <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\" target=\"_blank\">Customer Hierarchy</a> enabled."
},
"salesRep": {
"type": "string",
"maxLength": 50,
"description": "The name of the sales representative associated with this account, if applicable.\n"
},
"creditCard": {
"$ref": "#/components/schemas/creditCard"
},
"paymentTerm": {
"type": "string",
"description": "Name of the payment term associated with the account. For example, \"Net 30\". The payment term determines the due dates of invoices.\n"
},
"billCycleDay": {
"type": "integer",
"maximum": 31,
"minimum": 0,
"description": "Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\".\n"
},
"customFields": {
"$ref": "#/components/schemas/AccountObjectCustomFields"
},
"accountNumber": {
"type": "string",
"maxLength": 70,
"description": "Account number. For example, A00000001.\n"
},
"billToContact": {
"$ref": "#/components/schemas/BillToContactPostOrder"
},
"paymentMethod": {
"$ref": "#/components/schemas/POSTPaymentMethodRequest"
},
"soldToContact": {
"$ref": "#/components/schemas/SoldToContactPostOrder"
},
"paymentGateway": {
"type": "string",
"maxLength": 40,
"description": "The payment gateway that Zuora uses when processing electronic payments and refunds for the account. If you do not specify this field or if the value of this field is null, Zuora uses your default payment gateway.\n"
},
"allowInvoiceEdit": {
"type": "boolean",
"description": "Indicates if associated invoices can be edited.\nValues are: \n\n* `true`\n* `false` (default)\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "Internal identifier of the invoice template that Zuora uses when generating invoices for the account.\n"
},
"debitMemoTemplateId": {
"type": "string",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThe unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.\n"
},
"purchaseOrderNumber": {
"type": "string",
"maxLength": 100,
"description": "The number of the purchase order associated with this account. Purchase order information generally comes from customers.\n"
},
"creditMemoTemplateId": {
"type": "string",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThe unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.\n"
},
"communicationProfileId": {
"type": "string",
"description": "Internal identifier of the communication profile that Zuora uses when sending notifications to the account's contacts.\n"
},
"customerServiceRepName": {
"type": "string",
"maxLength": 50,
"description": "Name of the account's customer service representative, if applicable.\n"
},
"additionalEmailAddresses": {
"type": "string",
"maxLength": 1200,
"description": "List of additional email addresses to receive emailed invoices. Values should be a comma-separated list of email addresses.\n"
},
"invoiceDeliveryPrefsEmail": {
"type": "boolean",
"description": "Specifies whether to turn on the invoice delivery method 'Email' for the new account. \nValues are: \n\n* `true` (default). Turn on the invoice delivery method 'Email' for the new account.\n* `false`. Turn off the invoice delivery method 'Email' for the new account. \n"
},
"invoiceDeliveryPrefsPrint": {
"type": "boolean",
"description": "Specifies whether to turn on the invoice delivery method 'Print' for the new account.\nValues are: \n\n* `true`. Turn on the invoice delivery method 'Print' for the new account.\n* `false` (default). Turn off the invoice delivery method 'Print' for the new account.\n"
},
"hpmCreditCardPaymentMethodId": {
"type": "string",
"description": "The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.\n\nIf the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field,\nbut not both.\n\nFor the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the `paymentMethod` field to create a CC Reference Transaction payment method for an account.\n"
}
},
"description": "Information about a new account that will own the subscription. Only available if you have enabled the Owner Transfer feature.\n\n**Note:** The Owner Transfer 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\nIf you do not set this field or the `subscriptionOwnerAccountNumber` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `subscriptionOwnerAccountNumber` field.\n"
},
{
"$ref": "#/components/schemas/DataAccessControlField"
}
]
}
CreateOrderNewAccount
{
"allOf": [
{
"type": "object",
"required": [
"name",
"currency",
"billCycleDay",
"billToContact"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255
},
"batch": {
"type": "string",
"description": "**Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite\" target=\"_blank\">Performance Booster Elite</a> package.\n"
},
"crmId": {
"type": "string",
"maxLength": 100
},
"notes": {
"type": "string",
"maxLength": 65535
},
"autoPay": {
"type": "boolean",
"description": "Specifies whether future payments are to be automatically billed when they are due. Possible values are `true`, `false`."
},
"taxInfo": {
"$ref": "#/components/schemas/TaxInfo"
},
"currency": {
"type": "string",
"description": "3 uppercase character currency code.\n\nFor payment method authorization, if the `paymentMethod` > `currencyCode` field is specified, `currencyCode` is used. Otherwise, this `currency` field is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used.\n"
},
"parentId": {
"type": "string",
"description": "Identifier of the parent customer account for this Account object. Use this field if you have <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\" target=\"_blank\">Customer Hierarchy</a> enabled."
},
"salesRep": {
"type": "string",
"maxLength": 50,
"description": "The name of the sales representative associated with this account, if applicable.\n"
},
"creditCard": {
"$ref": "#/components/schemas/creditCard"
},
"paymentTerm": {
"type": "string",
"description": "**Note**: If you want to specify a payment term when creating a new account, you must set a value in this field. If you do not set a value in this field, Zuora will use `Due Upon Receipt` as the value instead of the default value set in **Billing Settings** > **Payment Terms** from Zuora UI.\n"
},
"billCycleDay": {
"type": "integer",
"maximum": 31,
"minimum": 0,
"description": "Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\"."
},
"customFields": {
"$ref": "#/components/schemas/AccountObjectCustomFields"
},
"accountNumber": {
"type": "string",
"maxLength": 70
},
"billToContact": {
"$ref": "#/components/schemas/BillToContactPostOrder"
},
"paymentMethod": {
"$ref": "#/components/schemas/POSTPaymentMethodRequest"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set to assign to the customer account. \n\nThe billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.\n"
},
"soldToContact": {
"$ref": "#/components/schemas/SoldToContactPostOrder"
},
"partnerAccount": {
"type": "boolean",
"default": false,
"description": "Whether the customer account is a partner, distributor, or reseller. \n\n\nYou can set this field to `true` if you have business with distributors or resellers, or operating in B2B model to manage numerous subscriptions through concurrent API requests. After this field is set to `true`, the calculation of account metrics is performed asynchronously during operations such as subscription creation, order changes, invoice generation, and payments.\n\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account\" target=\"_blank\">Reseller Account</a> feature enabled.\n"
},
"paymentGateway": {
"type": "string",
"maxLength": 40
},
"allowInvoiceEdit": {
"type": "boolean",
"description": "Indicates if associated invoices can be edited.\nValues are: \n\n* `true`\n* `false` (default)\n"
},
"invoiceTemplateId": {
"type": "string"
},
"organizationLabel": {
"type": "string",
"description": "Name of the organization that the account belongs to. \n\nThis field is only required when you have already turned on Multi-Org feature. \n"
},
"soldToSameAsBillTo": {
"type": "boolean",
"description": "Whether the sold-to contact and bill-to contact are the same entity. \n\nThe created account has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body:\n\n- This field is set to `true`. \n- A bill-to contact is specified.\n- No sold-to contact is specified.\n"
},
"debitMemoTemplateId": {
"type": "string",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThe unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.\n"
},
"purchaseOrderNumber": {
"type": "string",
"maxLength": 100,
"description": "The number of the purchase order associated with this account. Purchase order information generally comes from customers.\n"
},
"creditMemoTemplateId": {
"type": "string",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThe unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.\n"
},
"communicationProfileId": {
"type": "string"
},
"customerServiceRepName": {
"type": "string",
"maxLength": 50,
"description": "Name of the account's customer service representative, if applicable.\n"
},
"additionalEmailAddresses": {
"type": "string",
"maxLength": 1200,
"description": "List of additional email addresses to receive emailed invoices. Values should be a comma-separated list of email addresses.\n"
},
"invoiceDeliveryPrefsEmail": {
"type": "boolean",
"description": "Specifies whether to turn on the invoice delivery method 'Email' for the new account. \nValues are: \n\n* `true` (default). Turn on the invoice delivery method 'Email' for the new account.\n* `false`. Turn off the invoice delivery method 'Email' for the new account.\n"
},
"invoiceDeliveryPrefsPrint": {
"type": "boolean",
"description": "Specifies whether to turn on the invoice delivery method 'Print' for the new account.\nValues are: \n\n* `true`. Turn on the invoice delivery method 'Print' for the new account.\n* `false` (default). Turn off the invoice delivery method 'Print' for the new account.\n"
},
"hpmCreditCardPaymentMethodId": {
"type": "string",
"description": "The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.\n\nIf the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field,\nbut not both.\n\nFor the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the `paymentMethod` field to create a CC Reference Transaction payment method for an account.\n"
}
},
"description": "The information of the new account to be created with the order. Note that this actually specifies the invoice owner account of the subscriptions included in this order. To create the new account, either a **creditCard** structure or the **hpmCreditCardPaymentMethodId** field (but not both) should be provided. The one provided becomes the default payment method for this account. If the credit card information is declined or can't be verified, then the account is not created.\n"
},
{
"$ref": "#/components/schemas/DataAccessControlField"
}
]
}
CreateOrderOrderAction
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"CreateSubscription",
"TermsAndConditions",
"AddProduct",
"UpdateProduct",
"RemoveProduct",
"RenewSubscription",
"CancelSubscription",
"OwnerTransfer",
"Suspend",
"Resume",
"ChangePlan"
],
"type": "string",
"description": "Type of order action.\n\nUnless the type of order action is `RenewSubscription`, you must use the corresponding field to provide information about the order action. For example, if the type of order action is `AddProduct`, you must set the `addProduct` field.\n\nZuora returns an error if you set a field that corresponds to a different type of order action. For example, if the type of order action is `AddProduct`, Zuora returns an error if you set the `updateProduct` field.\n\nA [pending order](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/Pending_Order_and_Subscription) supports the following order actions:\n * CreateSubscription\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n * ChangePlan\n\nHowever, pending orders created through all order actions except for \"Create new subscription\":\n * Do not impact the subscription status.\n * Are in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). \n\nA pending order is created in either of the following conditions:\n * [Zuora is configured to require service activation](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F) and the service activation date is not set in your \"Create an order\" call.\n * [Zuora is configured to require customer acceptance](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F) and the customer acceptance date is not set in your \"Create an order\" call.\n * When a charge in the subscription has its `triggerEvent` field set as `SpecificDate` and the `specificTriggerDate` field is not set in your \"Create an order\" API call.\n\n**Note**: The change plan type of order action is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.\n"
},
"resume": {
"$ref": "#/components/schemas/CreateOrderResume"
},
"suspend": {
"$ref": "#/components/schemas/CreateOrderSuspend"
},
"addProduct": {
"$ref": "#/components/schemas/CreateOrderRatePlanOverride"
},
"changePlan": {
"$ref": "#/components/schemas/CreateChangePlan"
},
"changeReason": {
"type": "string",
"description": "The change reason set for an order action when an order is created.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderActionObjectCustomFields"
},
"triggerDates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerDate"
},
"description": "Container for the contract effective, service activation, and customer acceptance dates of the order action. \n\nIf [Zuora is configured to require service activation](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F) and the `ServiceActivation` field is not set for a `CreateSubscription` order action, a `Pending` order and a `Pending Activation` subscription are created.\n\nIf [Zuora is configured to require customer acceptance](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F) and the `CustomerAcceptance` field is not set for a `CreateSubscription` order action, a `Pending` order and a `Pending Acceptance` subscription are created. At the same time, if the service activation date field is also required and not set, a `Pending` order and a `Pending Activation` subscription are created instead.\n\nIf [Zuora is configured to require service activation](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F) and the `ServiceActivation` field is not set for either of the following order actions, a `Pending` order is created. The subscription status is not impacted. **Note:** This feature is in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n\nIf [Zuora is configured to require customer acceptance](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F) and the `CustomerAcceptance` field is not set for either of the following order actions, a `Pending` order is created. The subscription status is not impacted. **Note:** This feature is in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n"
},
"ownerTransfer": {
"$ref": "#/components/schemas/OwnerTransfer"
},
"removeProduct": {
"$ref": "#/components/schemas/RemoveProduct"
},
"updateProduct": {
"$ref": "#/components/schemas/CreateOrderRatePlanUpdate"
},
"renewSubscription": {
"$ref": "#/components/schemas/RenewSubscription"
},
"cancelSubscription": {
"$ref": "#/components/schemas/CancelSubscription"
},
"createSubscription": {
"$ref": "#/components/schemas/CreateOrderCreateSubscription"
},
"termsAndConditions": {
"$ref": "#/components/schemas/CreateOrderTermsAndConditions"
}
}
}
CreateOrderPricingUpdate
{
"type": "object",
"properties": {
"discount": {
"$ref": "#/components/schemas/DiscountPricingUpdate"
},
"usageTiered": {
"$ref": "#/components/schemas/UsageTieredPricingUpdate"
},
"usageVolume": {
"$ref": "#/components/schemas/UsageVolumePricingUpdate"
},
"usageFlatFee": {
"$ref": "#/components/schemas/UsageFlatFeePricingUpdate"
},
"usageOverage": {
"$ref": "#/components/schemas/UsageOveragePricingUpdate"
},
"usagePerUnit": {
"$ref": "#/components/schemas/UsagePerUnitPricingUpdate"
},
"chargeModelData": {
"$ref": "#/components/schemas/ChargeModelDataOverride"
},
"recurringTiered": {
"$ref": "#/components/schemas/RecurringTieredPricingUpdate"
},
"recurringVolume": {
"$ref": "#/components/schemas/RecurringVolumePricingUpdate"
},
"recurringFlatFee": {
"$ref": "#/components/schemas/RecurringFlatFeePricingUpdate"
},
"recurringPerUnit": {
"$ref": "#/components/schemas/RecurringPerUnitPricingUpdate"
},
"recurringDeliveryBased": {
"$ref": "#/components/schemas/RecurringDeliveryPricingUpdate"
},
"usageTieredWithOverage": {
"$ref": "#/components/schemas/UsageTieredWithOveragePricingUpdate"
}
},
"x-konfig-properties": {
"discount": {
"description": "Pricing information about a discount charge.\n"
},
"usageTiered": {
"description": "Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.\n"
},
"usageVolume": {
"description": "Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.\n"
},
"usageFlatFee": {
"description": "Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"
},
"usageOverage": {
"description": "Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.\n"
},
"usagePerUnit": {
"description": "Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.\n"
},
"chargeModelData": {
"description": "Container for charge model configuration data.\n\n**Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
},
"recurringTiered": {
"description": "Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n"
},
"recurringVolume": {
"description": "Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n"
},
"recurringFlatFee": {
"description": "Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"
},
"recurringPerUnit": {
"description": "Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n"
},
"recurringDeliveryBased": {
"description": "This field is only available if you have the Delivery Pricing charge model enabled.\n"
},
"usageTieredWithOverage": {
"description": "Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.\n"
}
}
}
CreateOrderRatePlanFeatureOverride
{
"type": "object",
"title": "ratePlanFeature",
"required": [
"featureId"
],
"properties": {
"featureId": {
"type": "string",
"description": "Internal identifier of the feature in the product catalog.\n"
},
"description": {
"type": "string",
"maxLength": 500,
"description": "A description of the feature."
},
"customFields": {
"$ref": "#/components/schemas/RatePlanFeatureOverrideCustomFields"
}
},
"description": "Information about feature in rate plan.\n"
}
CreateOrderRatePlanOverride
{
"type": "object",
"title": "ratePlan",
"properties": {
"uniqueToken": {
"type": "string",
"maxLength": 50,
"description": "Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrdersRatePlanObjectCustomFields"
},
"ratePlanName": {
"type": "string",
"description": "Name of the standalone rate plan.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"chargeOverrides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOrderChargeOverride"
},
"description": "List of charges associated with the rate plan.\n"
},
"productRatePlanId": {
"type": "string",
"description": "Internal identifier of the product rate plan that the rate plan is based on.\n"
},
"externalCatalogPlanId": {
"type": "string",
"description": "An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.\n\n**Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.\n"
},
"isFromExternalCatalog": {
"type": "boolean",
"description": "Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription.\n"
},
"externallyManagedPlanId": {
"type": "string",
"description": "Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n"
},
"clearingExistingFeatures": {
"type": "boolean",
"description": "Specifies whether all features in the rate plan will be cleared.\n"
},
"subscriptionRatePlanNumber": {
"type": "string",
"maxLength": 50,
"description": "Number of a subscription rate plan for this subscription.\n"
},
"subscriptionProductFeatures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOrderRatePlanFeatureOverride"
},
"description": "List of features associated with the rate plan.\nThe system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:\n* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.\n* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.\n"
}
},
"description": "Information about an order action of type `AddProduct`. \n\nIf you want to create a pending order through the \"Add product\" order action, and if the charge's trigger condition is `Specific Date`, you must set a charge number in the `chargeNumber` field for the \"Add product\" order action. In this case, if you do not set it, Zuora will not generate the charge number for you.\n\nSee more information about pending orders in <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/Pending_orders_and_subscriptions\" target=\"_blank\">Pending orders and subscriptions</a>. \n"
}
CreateOrderRatePlanUpdate
{
"type": "object",
"title": "updateRateplan",
"properties": {
"ratePlanId": {
"type": "string",
"description": "The id of the rate plan to be updated. It can be the latest version or any history version id.\n"
},
"uniqueToken": {
"type": "string",
"description": "A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrdersRatePlanObjectCustomFields"
},
"chargeUpdates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOrderChargeUpdate"
},
"description": "Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.\n"
},
"specificUpdateDate": {
"type": "string",
"format": "date",
"description": "The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.\n\nSee [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.\n"
},
"externalCatalogPlanId": {
"type": "string",
"description": "An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.\n\n**Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription.\n"
},
"clearingExistingFeatures": {
"type": "boolean",
"description": "Specifies whether all features in the rate plan will be cleared.\n"
},
"subscriptionRatePlanNumber": {
"type": "string",
"description": "Number of a rate plan for this subscription.\n"
},
"subscriptionProductFeatures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOrderRatePlanFeatureOverride"
},
"description": "List of features associated with the rate plan.\nThe system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:\n* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.\n* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.\n"
}
},
"description": "Information about an order action of type `UpdateProduct`.\n"
}
CreateOrderResume
{
"type": "object",
"title": "Resume",
"required": [
"resumePolicy"
],
"properties": {
"extendsTerm": {
"type": "boolean",
"description": "Specifies whether to extend the subscription term by the length of time the suspension is in effect.\n"
},
"resumePolicy": {
"enum": [
"Today",
"FixedPeriodsFromSuspendDate",
"FixedPeriodsFromToday",
"SpecificDate",
"SuspendDate"
],
"type": "string",
"description": "Resume methods. Specify a way to resume a subscription. See [Resume Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Resume_a_Subscription#Resume_Date) for more information.\n\nIf `SuspendDate` is specfied, the resumption will take place on the same day as the suspension. \n"
},
"resumePeriods": {
"type": "integer",
"description": "This field is applicable only when the `resumePolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must be used together with the `resumePeriodsType` field. \n\nThe total number of the periods used to specify when a subscription resumption takes effect. The subscription resumption will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
},
"resumePeriodsType": {
"enum": [
"Day",
"Week",
"Month",
"Year"
],
"type": "string",
"description": "This field is applicable only when the `resumePolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must be used together with the `resumePeriods` field.\n\nThe period type used to specify when a subscription resumption takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
},
"resumeSpecificDate": {
"type": "string",
"format": "date",
"description": "This field is applicable only when the `resumePolicy` field is set to `SpecificDate`.\n\nA specific date when the subscription resumption takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription suspension date.\n"
}
},
"description": "Information about an order action of type `Resume`.\n"
}
CreateOrderSuspend
{
"type": "object",
"title": "Suspend",
"required": [
"suspendPolicy"
],
"properties": {
"suspendPolicy": {
"enum": [
"Today",
"EndOfLastInvoicePeriod",
"FixedPeriodsFromToday",
"SpecificDate"
],
"type": "string",
"description": "Suspend methods. Specify a way to suspend a subscription. See [Suspend Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Suspend_a_Subscription#Suspend_Date) for more information.\n"
},
"suspendPeriods": {
"type": "integer",
"description": "This field is applicable only when the `suspendPolicy` field is set to `FixedPeriodsFromToday`. It must be used together with the `suspendPeriodsType` field. \n\nThe total number of the periods used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
},
"suspendPeriodsType": {
"enum": [
"Day",
"Week",
"Month",
"Year"
],
"type": "string",
"description": "This field is applicable only when the `suspendPolicy` field is set to `FixedPeriodsFromToday`. It must be used together with the `suspendPeriods` field.\n\nThe period type used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
},
"suspendSpecificDate": {
"type": "string",
"format": "date",
"description": "This field is applicable only when the `suspendPolicy` field is set to `SpecificDate`.\n\nA specific date when the subscription suspension takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription's contract effective date or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) than the subscription's term end date.\n"
}
},
"description": "Information about an order action of type `Suspend`.\n"
}
CreateOrderTermsAndConditions
{
"type": "object",
"title": "termsAndConditions",
"properties": {
"lastTerm": {
"$ref": "#/components/schemas/LastTerm"
},
"autoRenew": {
"type": "boolean"
},
"paymentTerm": {
"type": "string",
"description": "The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"renewalTerms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RenewalTerm"
}
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"renewalSetting": {
"enum": [
"RENEW_WITH_SPECIFIC_TERM",
"RENEW_TO_EVERGREEN"
],
"type": "string"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"maxLength": 255,
"description": "The number of the invoice group associated with the subscription.\n\nAfter enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"clearingExistingPaymentTerm": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingSequenceSet": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingBillToContact": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingSoldToContact": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingInvoiceTemplate": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingInvoiceGroupNumber": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
}
},
"description": "Information about an order action of type `TermsAndConditions`.\n"
}
CreateOrderTriggerParams
{
"type": "object",
"title": "startDate",
"properties": {
"triggerEvent": {
"enum": [
"ContractEffective",
"ServiceActivation",
"CustomerAcceptance",
"SpecificDate"
],
"type": "string",
"description": "Condition for the charge to become active.\n\nIf the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.\n"
},
"startDatePolicy": {
"enum": [
"AlignToApplyToCharge",
"SpecificDate",
"EndOfLastInvoicePeriodOfApplyToCharge",
"FixedPeriodAfterApplyToChargeStartDate"
],
"type": "string",
"description": "Start date policy of the discount charge to become active when the **Apply to billing period partially** checkbox is selected from the product catalog UI or the `applyToBillingPeriodPartially` field is set as true from the \"CRUD: Create a product rate plan charge\" operation.\n\n- If the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.\n- If the value of this field is `FixedPeriodAfterApplyToChargeStartDate`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields.\n\n**Notes**: \n - You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field. \n - You can use either `triggerEvent` or `startDatePolicy` to define when a discount charge starts, but not both at the same time.\n"
},
"startPeriodsType": {
"enum": [
"Days",
"Weeks",
"Months",
"Years"
],
"type": "string",
"description": "Unit of time that the discount charge duration is measured in. Only applicable if the value of the `startDatePolicy` field is `FixedPeriodAfterApplyToChargeStartDate`.\n\n**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.\n"
},
"specificTriggerDate": {
"type": "string",
"format": "date",
"description": "Date in YYYY-MM-DD format. Only applicable if the value of the `triggerEvent` field is `SpecificDate`. \n\nWhile this field is applicable, if this field is not set, your `CreateSubscription` order action creates a `Pending` order and a `Pending Acceptance` subscription. If at the same time the service activation date is required and not set, a `Pending Activation` subscription is created.\n\nWhile this field is applicable, if this field is not set, the following order actions create a `Pending` order but do not impact the subscription status. **Note**: This feature is in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n"
},
"periodsAfterChargeStart": {
"type": "integer",
"description": "Duration of the discount charge in days, weeks, months, or years, depending on the value of the `startPeriodsType` field. Only applicable if the value of the `startDatePolicy` field is `FixedPeriodAfterApplyToChargeStartDate`.\n\n**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.\n"
}
},
"description": "Specifies when a charge becomes active.\n"
}
CreateOrderUpdateProductTriggerParams
{
"type": "object",
"title": "startDate",
"properties": {
"triggerEvent": {
"enum": [
"ContractEffective",
"ServiceActivation",
"CustomerAcceptance",
"SpecificDate"
],
"type": "string",
"description": "Condition for the charge to become active. If this field is not specified, the value of the field will be defaulted to the trigger event value defined in the product catalog.\n\nIf the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.\n"
},
"specificTriggerDate": {
"type": "string",
"format": "date",
"description": "Date in YYYY-MM-DD format. Only applicable if the value of the `triggerEvent` field is `SpecificDate`. \n\nWhile this field is applicable, if this field is not set, your `CreateSubscription` order action creates a `Pending` order and a `Pending Acceptance` subscription. If at the same time the service activation date is required and not set, a `Pending Activation` subscription is created.\n\nWhile this field is applicable, if this field is not set, the following order actions create a `Pending` order but do not impact the subscription status. **Note**: This feature is in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n\nWhile this field is applicable, for the `updateProduct` order action, if the Pending order feature as above is not enabled, this field must not be set to null.\n"
}
},
"description": "Specifies when a charge becomes active.\n"
}
CreatePMPayPalCP
{
"allOf": [
{
"type": "object",
"properties": {
"BAID": {
"type": "string",
"example": "I-1TJ3GAGG82Y9",
"description": "ID of a PayPal billing agreement.\n"
},
"type": {
"type": "string"
},
"email": {
"type": "string",
"description": "Email address associated with the payment method.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
}
],
"example": {
"BAID": "I-1TJ3GAGG82Y9",
"type": "PayPalCP",
"email": "customer@example.com",
"accountKey": "8a90d6128d45df2b018d4b90681c05x0"
},
"required": [
"type",
"BAID",
"email"
]
}
CreatePMPayPalEC
{
"allOf": [
{
"type": "object",
"properties": {
"BAID": {
"type": "string",
"example": "I-1TJ3GAGG82Y9",
"description": "ID of a PayPal billing agreement.\n"
},
"type": {
"type": "string"
},
"email": {
"type": "string",
"description": "Email address associated with the payment method.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
}
],
"example": {
"BAID": "I-1TJ3GAGG82Y9",
"type": "PayPalEC",
"email": "customer@example.com",
"accountKey": "8a90d6128d45df2b018d4b90681c05x0"
},
"required": [
"type",
"BAID",
"email"
]
}
CreatePMPayPalNativeEC
{
"allOf": [
{
"type": "object",
"properties": {
"BAID": {
"type": "string",
"description": "ID of a PayPal billing agreement. \nexample: I-1TJ3GAGG82Y9\n"
},
"type": {
"type": "string"
},
"email": {
"type": "string",
"description": "Email address associated with the payment method.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
}
],
"example": {
"BAID": "I-1TJ3GAGG82Y9",
"type": "PayPalNativeEC",
"email": "customer@example.com",
"accountKey": "8a90d6128d45df2b018d4b90681c05x0"
},
"required": [
"type",
"BAID"
]
}
CreatePaymentMethodACH
{
"allOf": [
{
"type": "object",
"title": "AchPaymentMethod",
"properties": {
"city": {
"type": "string",
"description": "City, 40 characters or less.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n \n"
},
"type": {
"type": "string"
},
"phone": {
"type": "string",
"description": "Phone number, 40 characters or less.\n"
},
"state": {
"type": "string",
"description": "State, must be a valid state name or 2-character abbreviation.\n\nSee [United States Standard State Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/B_State_Names_and_2-Digit_Codes) and [Canadian Standard Province Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/C_Canadian_Province_Names_and_2-Digit_Codes) for the list of supported names and abbreviations.\n"
},
"tokens": {
"type": "object",
"required": [
"gatewayType",
"tokenId"
],
"properties": {
"tokenId": {
"type": "string",
"description": "Pass in the first token of the payment method. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration#ACH\" target=\"_blank\">Overview of Stripe payment gateway integration</a>.\n"
},
"gatewayType": {
"enum": [
"Stripe"
],
"type": "string",
"description": "The type of the payment gateway to generate the tokens. This field is case-sensitive.\n"
},
"thirdTokenId": {
"type": "string",
"description": "Pass in the third token of the payment method.\n"
},
"secondTokenId": {
"type": "string",
"description": "Pass in the second token of the payment method. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration#ACH\" target=\"_blank\">Overview of Stripe payment gateway integration</a>.\n"
}
},
"description": "To create tokenized ACH payment methods on Stripe v2, pass in the existing token information through the fields in this container.\n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration#ACH\" target=\"_blank\">Overview of Stripe payment gateway integration</a>.\n"
},
"country": {
"type": "string",
"description": "Country, must be a valid country name or abbreviation.\n\nSee <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions\" target=\"_blank\">View countries or regions</a> for the list of supported country names and abbreviations.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"zipCode": {
"type": "string",
"description": "Zip code, 20 characters or less.\n"
},
"bankName": {
"type": "string",
"maxLength": 70,
"description": "The name of the bank where the ACH payment account is held.\n\nWhen creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value.\n"
},
"bankABACode": {
"type": "string",
"description": "The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`.\n"
},
"mandateInfo": {
"type": "object",
"properties": {
"mandateId": {
"type": "string",
"maxLength": 36,
"description": "The mandate ID.\n"
},
"mandateReason": {
"type": "string",
"maxLength": 64,
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"maxLength": 64,
"description": "The status of the mandate from the gateway side.\n"
}
},
"description": "The container of the mandate information for the payment method.\n"
},
"addressLine1": {
"type": "string",
"description": "First address line, 255 characters or less.\n"
},
"addressLine2": {
"type": "string",
"description": "Second address line, 255 characters or less.\n"
},
"bankAccountName": {
"type": "string",
"maxLength": 70,
"description": "The name of the account holder, which can be either a person or a company.\n\nFor ACH payment methods on the BlueSnap integration, see [Overview of BlueSnap gateway integration](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/BlueSnap_Gateway/Overview_of_BlueSnap_gateway_integration#Payer_Name_Extraction) for more information about how Zuora splits the string in this field into two parts and passes them to BlueSnap's `firstName` and `lastName` fields.\n"
},
"bankAccountType": {
"enum": [
"BusinessChecking",
"Checking",
"Saving"
],
"type": "string",
"description": "The type of bank account associated with the ACH payment.\n\nWhen creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, `Checking` preferably.\n"
},
"bankAccountNumber": {
"type": "string",
"maxLength": 30,
"description": "The bank account number associated with the ACH payment.\n\nThis field is required if the `type` field is set to `ACH`. However, for creating tokenized ACH payment methods on Stripe v2, this field is optional if the `tokens` and `bankAccountMaskNumber` fields are specified. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration#ACH\" target=\"_blank\">Overview of Stripe payment gateway integration</a>.\n"
},
"processingOptions": {
"type": "object",
"properties": {
"checkDuplicated": {
"type": "boolean",
"description": "Indicates whether to perform a duplication check when you create a payment method.\n\nThe default value is `false`.\n\nWith this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. \n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods\" target=\"_blank\">Duplication check on payment methods</a>.\n"
}
},
"description": "The container for payment method processing options.\n"
},
"bankAccountMaskNumber": {
"type": "string",
"description": "The masked account number such as ****1234. \n\nWhen creating ACH payment methods on Stripe v2, if the `tokens` field is provided, this `bankAccountMaskNumber` field is required. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration#ACH\" target=\"_blank\">Overview of Stripe payment gateway integration</a>.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
}
],
"example": {
"city": "testCity",
"type": "ACH",
"phone": "1234567890",
"state": "Alaska",
"country": "USA",
"zipCode": "123456",
"bankName": "TestBank",
"accountKey": "8a90d6128d45df2b018d4b90681c05x0",
"bankABACode": "999999999",
"addressLine1": "Test Address line1",
"addressLine2": "Test Address line2",
"bankAccountName": "TestName",
"bankAccountType": "Checking",
"bankAccountNumber": "999999999",
"processingOptions": {
"checkDuplicated": true
}
},
"required": [
"type",
"bankABACode",
"bankAccountName",
"bankAccountNumber",
"bankAccountType",
"bankName"
]
}
CreatePaymentMethodApplePayAdyen
{
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address associated with the payment method. This field is specific for setting up Apple Pay on Adyen v2.0. This field will be passed to Adyen as `shopperEmail`.\n"
},
"applePaymentData": {
"type": "string",
"description": "This field is specific for setting up Apple Pay for Adyen to include payload with Apple Pay token or Apple payment data. This information should be stringified. For more information, see [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay).\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
}
],
"example": {
"type": "AdyenApplePay",
"email": "testemail@test.com",
"accountKey": "2c92c0f97911f46a0179147510484b90",
"applePaymentData": "{\"data\":\"hM8GTBX0UVhoKmJ/DkneZfwLlH/utWfEueshybbTpuzlf5i1IwO1kvW32SlFW7TmyvU98gf2Pp1FeyFCh7F2atmstxQdonkeJgpIUV7eWW1wUNaOeND28J8YQsEkDhC3sMgOJoju7FHcXNwveq5fk94StFZozRSi08oAjTnTJko5F32aY/JNWr19GiwWBHZe2jkokryt0TEWKO5hm5oTxeLs1LBOoC2ezaR+p2jQb4ISN2aCgCNiX8605w5eYWk7UCTK3Axf/EuJT4vHe75OKghEmcQLxvFzTtEw33ly6Nj2RJX3+I5TbYLXOfiAO0XnsWdhguDrKogtI44HMFqlNCdt79G71tXwCwbXz0VJywEh1d57tbU5Y5f6pw8TrjjeAMt9sa2pHuHmMGDf\",\"signature\":\"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIID5DCCA4ugAwIBAgIIWdihvKr0480wCgYIKoZIzj0EAwIwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTIxMDQyMDE5MzcwMFoXDTI2MDQxOTE5MzY1OVowYjEoMCYGA1UEAwwfZWNjLXNtcC1icm9rZXItc2lnbl9VQzQtU0FOREJPWDEUMBIGA1UECwwLaU9TIFN5c3RlbXMxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEgjD9q8Oc914gLFDZm0US5jfiqQHdbLPgsc1LUmeY+M9OvegaJajCHkwz3c6OKpbC9q+hkwNFxOh6RCbOlRsSlaOCAhEwggINMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUI/JJxE+T5O8n5sT2KGw/orv9LkswRQYIKwYBBQUHAQEEOTA3MDUGCCsGAQUFBzABhilodHRwOi8vb2NzcC5hcHBsZS5jb20vb2NzcDA0LWFwcGxlYWljYTMwMjCCAR0GA1UdIASCARQwggEQMIIBDAYJKoZIhvdjZAUBMIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMgY2VydGlmaWNhdGUgYnkgYW55IHBhcnR5IGFzc3VtZXMgYWNjZXB0YW5jZSBvZiB0aGUgdGhlbiBhcHBsaWNhYmxlIHN0YW5kYXJkIHRlcm1zIGFuZCBjb25kaXRpb25zIG9mIHVzZSwgY2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZpY2F0aW9uIHByYWN0aWNlIHN0YXRlbWVudHMuMDYGCCsGAQUFBwIBFipodHRwOi8vd3d3LmFwcGxlLmNvbS9jZXJ0aWZpY2F0ZWF1dGhvcml0eS8wNAYDVR0fBC0wKzApoCegJYYjaHR0cDovL2NybC5hcHBsZS5jb20vYXBwbGVhaWNhMy5jcmwwHQYDVR0OBBYEFAIkMAua7u1GMZekplopnkJxghxFMA4GA1UdDwEB/wQEAwIHgDAPBgkqhkiG92NkBh0EAgUAMAoGCCqGSM49BAMCA0cAMEQCIHShsyTbQklDDdMnTFB0xICNmh9IDjqFxcE2JWYyX7yjAiBpNpBTq/ULWlL59gBNxYqtbFCn1ghoN5DgpzrQHkrZgTCCAu4wggJ1oAMCAQICCEltL786mNqXMAoGCCqGSM49BAMCMGcxGzAZBgNVBAMMEkFwcGxlIFJvb3QgQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE0MDUwNjIzNDYzMFoXDTI5MDUwNjIzNDYzMFowejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8BcRhBnXZIXVGl4lgQd26ICi7957rk3gjfxLk+EzVtVmWzWuItCXdg0iTnu6CP12F86Iy3a7ZnC+yOgphP9URaOB9zCB9DBGBggrBgEFBQcBAQQ6MDgwNgYIKwYBBQUHMAGGKmh0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDQtYXBwbGVyb290Y2FnMzAdBgNVHQ4EFgQUI/JJxE+T5O8n5sT2KGw/orv9LkswDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBS7sN6hWDOImqSKmd6+veuv2sskqzA3BgNVHR8EMDAuMCygKqAohiZodHRwOi8vY3JsLmFwcGxlLmNvbS9hcHBsZXJvb3RjYWczLmNybDAOBgNVHQ8BAf8EBAMCAQYwEAYKKoZIhvdjZAYCDgQCBQAwCgYIKoZIzj0EAwIDZwAwZAIwOs9yg1EWmbGG+zXDVspiv/QX7dkPdU2ijr7xnIFeQreJ+Jj3m1mfmNVBDY+d6cL+AjAyLdVEIbCjBXdsXfM4O5Bn/Rd8LCFtlk/GcmmCEm9U+Hp9G5nLmwmJIWEGmQ8Jkh0AADGCAYswggGHAgEBMIGGMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUwIIWdihvKr0480wDQYJYIZIAWUDBAIBBQCggZUwGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxDxcNMjEwNjAzMTgzNzExWjAqBgkqhkiG9w0BCTQxHTAbMA0GCWCGSAFlAwQCAQUAoQoGCCqGSM49BAMCMC8GCSqGSIb3DQEJBDEiBCCiDFBojwOJgYgEzWaGdLTMez4XiDpYJd34PswTPVdt+DAKBggqhkjOPQQDAgRGMEQCIHAWYyr/s28rtd/khGapLi1jCg3iXwgUfL2l4XadiKq3AiBHuronD982WBP3x0Tzc51rXwMEVpL+GDPme9Ydn2MF2gAAAAAAAA==\", \"header\": { \"publicKeyHash\":\"vJeh5XAkv8SGX2JHswEbnCUPn01YHcQ6imAp+gP300w=\", \"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEVx9kP/eFM6MrP5sXKuzHT7f9Uhsc0Rox0FKvRpHIiqQ05EXYPsgBJZCEjOYlkviC2jDSvV6tEC8Kfq/z/GhrFA==\", \"transactionId\":\"7fd9ede5ea8c1d7a8985346c241a8933190a1acb408448c52ac27f7862f674ff\" }, \"version\":\"EC_v1\" }"
},
"required": [
"type",
"applePaymentData"
]
}
CreatePaymentMethodAutogiro
{
"allOf": [
{
"type": "object",
"title": "AutogiroPaymentMethod",
"properties": {
"type": {
"type": "string"
},
"branchCode": {
"type": "string",
"description": "The branch code of the bank used for direct debit.\n"
},
"mandateInfo": {
"type": "object",
"properties": {
"mandateId": {
"type": "string",
"maxLength": 36,
"description": "The mandate ID.\n"
},
"mandateReason": {
"type": "string",
"maxLength": 64,
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"maxLength": 64,
"description": "The status of the mandate from the gateway side.\n"
}
},
"description": "The container of the mandate information for the payment method.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer's bank account.\n"
},
"identityNumber": {
"type": "string",
"description": "The identity number used for Bank Transfer.\n"
},
"accountHolderInfo": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city where the account holder stays.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"email": {
"type": "string",
"description": "The email address of the account holder.\n"
},
"phone": {
"type": "string",
"description": "The phone number of the account holder.\n"
},
"state": {
"type": "string",
"description": "The state where the account holder stays.\n"
},
"country": {
"type": "string",
"description": "The country where the account holder stays.\n"
},
"zipCode": {
"type": "string",
"description": "The zip code for the address of the account holder.\n"
},
"lastName": {
"type": "string",
"description": "The last name of the account holder.\n"
},
"firstName": {
"type": "string",
"description": "The first name of the account holder.\n"
},
"addressLine1": {
"type": "string",
"description": "The first line of the address for the account holder.\n"
},
"addressLine2": {
"type": "string",
"description": "The second line of the address for the account holder. \n"
},
"accountHolderName": {
"type": "string",
"maxLength": 60,
"description": "Required.\n\nThe full name of the bank account holder.\n"
}
},
"description": "The container for the account holder information. The nested `accountHolderName` field is required.\n"
},
"accountMaskNumber": {
"type": "string",
"description": "The masked account number such as ****1234.\n"
},
"processingOptions": {
"type": "object",
"properties": {
"checkDuplicated": {
"type": "boolean",
"description": "Indicates whether to perform a duplication check when you create a payment method.\n\nThe default value is `false`.\n\nWith this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. \n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods\" target=\"_blank\">Duplication check on payment methods</a>.\n"
}
},
"description": "The container for payment method processing options.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
}
],
"example": {
"type": "Autogiro",
"accountKey": "8a90d6128d45df2b018d4b90681c05x0",
"branchCode": "5491",
"accountNumber": "0000003",
"identityNumber": "198112289874",
"accountHolderInfo": {
"accountHolderName": "TestName"
},
"processingOptions": {
"checkDuplicated": true
}
},
"required": [
"type",
"accountNumber",
"identityNumber",
"branchCode",
"accountHolderInfo"
]
}
CreatePaymentMethodBacs
{
"allOf": [
{
"type": "object",
"title": "BacsPaymentMethod",
"properties": {
"type": {
"type": "string"
},
"tokens": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"description": "Required. \n\nPass in the first token of the payment method. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration\" target=\"_blank\">Overview of Stripe payment gateway integration</a>.\n"
},
"gatewayType": {
"enum": [
"Stripe"
],
"type": "string",
"description": "Required. \n\nThe type of the payment gateway to generate the tokens. This field is case-sensitive.\n"
},
"thirdTokenId": {
"type": "string",
"description": "Pass in the third token of the payment method.\n"
},
"secondTokenId": {
"type": "string",
"description": "Pass in the second token of the payment method. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration\" target=\"_blank\">Overview of Stripe payment gateway integration</a>.\n"
}
},
"description": "To create tokenized BACS payment methods on Stripe v2, pass in the existing token information through the fields in this container.\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration\" target=\"_blank\">Overview of Stripe payment gateway integration</a>.\n"
},
"bankCode": {
"type": "string",
"description": "The sort code or number that identifies the bank. This is also known as the sort code.\n"
},
"tokenize": {
"type": "boolean",
"default": false,
"description": "When creating a BACS payment method on Adyen v2.0, set this field to `true` to support processing BACS recurring payments. For more information about other requirements for processing BACS recurring payments, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Adyen_Integration_v2.0/A_Overview_of_Adyen_Integration_v2.0#Direct_Debit_UK_(BACS)\" target=\"_blank\">Overview of Adyen Integration v2.0</a>.\n"
},
"mandateInfo": {
"type": "object",
"properties": {
"mandateId": {
"type": "string",
"maxLength": 36,
"description": "The mandate ID.\n"
},
"mandateReason": {
"type": "string",
"maxLength": 64,
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"maxLength": 64,
"description": "The status of the mandate from the gateway side.\n"
}
},
"description": "The container of the mandate information for the payment method.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer's bank account.\n"
},
"accountHolderInfo": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city where the account holder stays.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"email": {
"type": "string",
"description": "The email address of the account holder.\n"
},
"phone": {
"type": "string",
"description": "The phone number of the account holder.\n"
},
"state": {
"type": "string",
"description": "The state where the account holder stays.\n"
},
"country": {
"type": "string",
"description": "The country where the account holder stays.\n"
},
"zipCode": {
"type": "string",
"description": "The zip code for the address of the account holder.\n"
},
"lastName": {
"type": "string",
"description": "The last name of the account holder.\n"
},
"firstName": {
"type": "string",
"description": "The first name of the account holder.\n"
},
"addressLine1": {
"type": "string",
"description": "The first line of the address for the account holder.\n"
},
"addressLine2": {
"type": "string",
"description": "The second line of the address for the account holder. \n"
},
"accountHolderName": {
"type": "string",
"maxLength": 60,
"description": "Required.\n\nThe full name of the bank account holder.\n"
}
},
"description": "The container for the account holder information. The nested `accountHolderName` field is required.\n"
},
"accountMaskNumber": {
"type": "string",
"description": "The masked account number such as ****1234.\nWhen creating BACS payment methods on Stripe, if the `tokens` field is provided, this `accountMaskNumber` field is required. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration\" target=\"_blank\">Overview of Stripe payment gateway integration</a>.\n"
},
"processingOptions": {
"type": "object",
"properties": {
"checkDuplicated": {
"type": "boolean",
"description": "Indicates whether to perform a duplication check when you create a payment method.\n\nThe default value is `false`.\n\nWith this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. \n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods\" target=\"_blank\">Duplication check on payment methods</a>.\n"
}
},
"description": "The container for payment method processing options.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
}
],
"example": {
"type": "Bacs",
"bankCode": "200000",
"accountKey": "8a90d6128d45df2b018d4b90681c05x0",
"accountNumber": "55779911",
"identityNumber": "0101701234",
"accountHolderInfo": {
"accountHolderName": "TestName"
},
"processingOptions": {
"checkDuplicated": true
}
},
"required": [
"type",
"accountNumber",
"bankCode",
"accountHolderInfo"
]
}
CreatePaymentMethodBecs
{
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"branchCode": {
"type": "string",
"description": "The branch code of the bank used for direct debit.\n"
},
"mandateInfo": {
"type": "object",
"properties": {
"mandateId": {
"type": "string",
"maxLength": 36,
"description": "The mandate ID.\n"
},
"mandateReason": {
"type": "string",
"maxLength": 64,
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"maxLength": 64,
"description": "The status of the mandate from the gateway side.\n"
}
},
"description": "The container of the mandate information for the payment method.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer's bank account.\n"
},
"accountHolderInfo": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city where the account holder stays.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"email": {
"type": "string",
"description": "The email address of the account holder.\n"
},
"phone": {
"type": "string",
"description": "The phone number of the account holder.\n"
},
"state": {
"type": "string",
"description": "The state where the account holder stays.\n"
},
"country": {
"type": "string",
"description": "The country where the account holder stays.\n"
},
"zipCode": {
"type": "string",
"description": "The zip code for the address of the account holder.\n"
},
"lastName": {
"type": "string",
"description": "The last name of the account holder.\n"
},
"firstName": {
"type": "string",
"description": "The first name of the account holder.\n"
},
"addressLine1": {
"type": "string",
"description": "The first line of the address for the account holder.\n"
},
"addressLine2": {
"type": "string",
"description": "The second line of the address for the account holder. \n"
},
"accountHolderName": {
"type": "string",
"maxLength": 60,
"description": "Required.\n\nThe full name of the bank account holder.\n"
}
},
"description": "The container for the account holder information. The nested `accountHolderName` field is required.\n"
},
"accountMaskNumber": {
"type": "string",
"description": "The masked account number such as ****1234.\n"
},
"processingOptions": {
"type": "object",
"properties": {
"checkDuplicated": {
"type": "boolean",
"description": "Indicates whether to perform a duplication check when you create a payment method.\n\nThe default value is `false`.\n\nWith this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. \n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods\" target=\"_blank\">Duplication check on payment methods</a>.\n"
}
},
"description": "The container for payment method processing options.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
}
],
"example": {
"type": "Becs",
"accountKey": "8a90d6128d45df2b018d4b90681c05x0",
"branchCode": "082-082",
"accountNumber": "012345678",
"accountHolderInfo": {
"accountHolderName": "TestName"
},
"processingOptions": {
"checkDuplicated": true
}
},
"required": [
"type",
"accountNumber",
"branchCode"
]
}
CreatePaymentMethodBecsnz
{
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"bankCode": {
"type": "string",
"description": "The sort code or number that identifies the bank. This is also known as the sort code.\n"
},
"branchCode": {
"type": "string",
"description": "The branch code of the bank used for direct debit.\n"
},
"mandateInfo": {
"type": "object",
"properties": {
"mandateId": {
"type": "string",
"maxLength": 36,
"description": "The mandate ID.\n"
},
"mandateReason": {
"type": "string",
"maxLength": 64,
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"maxLength": 64,
"description": "The status of the mandate from the gateway side.\n"
}
},
"description": "The container of the mandate information for the payment method.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer's bank account.\n"
},
"accountHolderInfo": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city where the account holder stays.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"email": {
"type": "string",
"description": "The email address of the account holder.\n"
},
"phone": {
"type": "string",
"description": "The phone number of the account holder.\n"
},
"state": {
"type": "string",
"description": "The state where the account holder stays.\n"
},
"country": {
"type": "string",
"description": "The country where the account holder stays.\n"
},
"zipCode": {
"type": "string",
"description": "The zip code for the address of the account holder.\n"
},
"lastName": {
"type": "string",
"description": "The last name of the account holder.\n"
},
"firstName": {
"type": "string",
"description": "The first name of the account holder.\n"
},
"addressLine1": {
"type": "string",
"description": "The first line of the address for the account holder.\n"
},
"addressLine2": {
"type": "string",
"description": "The second line of the address for the account holder. \n"
},
"accountHolderName": {
"type": "string",
"maxLength": 60,
"description": "Required.\n\nThe full name of the bank account holder.\n"
}
},
"description": "The container for the account holder information. The nested `accountHolderName` field is required.\n"
},
"accountMaskNumber": {
"type": "string",
"description": "The masked account number such as ****1234.\n"
},
"processingOptions": {
"type": "object",
"properties": {
"checkDuplicated": {
"type": "boolean",
"description": "Indicates whether to perform a duplication check when you create a payment method.\n\nThe default value is `false`.\n\nWith this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. \n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods\" target=\"_blank\">Duplication check on payment methods</a>.\n"
}
},
"description": "The container for payment method processing options.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
}
],
"example": {
"type": "Becsnz",
"bankCode": "12",
"accountKey": "8a90d6128d45df2b018d4b90681c05x0",
"branchCode": "3113",
"accountNumber": "0003869-00",
"accountHolderInfo": {
"accountHolderName": "TestName"
},
"processingOptions": {
"checkDuplicated": true
}
},
"required": [
"type",
"accountNumber",
"bankCode",
"branchCode",
"accountHolderInfo"
]
}
CreatePaymentMethodBetalingsservice
{
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"bankCode": {
"type": "string",
"description": "The sort code or number that identifies the bank. This is also known as the sort code.\n"
},
"mandateInfo": {
"type": "object",
"properties": {
"mandateId": {
"type": "string",
"maxLength": 36,
"description": "The mandate ID.\n"
},
"mandateReason": {
"type": "string",
"maxLength": 64,
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"maxLength": 64,
"description": "The status of the mandate from the gateway side.\n"
}
},
"description": "The container of the mandate information for the payment method.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer's bank account.\n"
},
"identityNumber": {
"type": "string",
"description": "The identity number used for Bank Transfer.\n"
},
"accountHolderInfo": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city where the account holder stays.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"email": {
"type": "string",
"description": "The email address of the account holder.\n"
},
"phone": {
"type": "string",
"description": "The phone number of the account holder.\n"
},
"state": {
"type": "string",
"description": "The state where the account holder stays.\n"
},
"country": {
"type": "string",
"description": "The country where the account holder stays.\n"
},
"zipCode": {
"type": "string",
"description": "The zip code for the address of the account holder.\n"
},
"lastName": {
"type": "string",
"description": "The last name of the account holder.\n"
},
"firstName": {
"type": "string",
"description": "The first name of the account holder.\n"
},
"addressLine1": {
"type": "string",
"description": "The first line of the address for the account holder.\n"
},
"addressLine2": {
"type": "string",
"description": "The second line of the address for the account holder. \n"
},
"accountHolderName": {
"type": "string",
"maxLength": 60,
"description": "Required.\n\nThe full name of the bank account holder.\n"
}
},
"description": "The container for the account holder information. The nested `accountHolderName` field is required.\n"
},
"accountMaskNumber": {
"type": "string",
"description": "The masked account number such as ****1234.\n"
},
"processingOptions": {
"type": "object",
"properties": {
"checkDuplicated": {
"type": "boolean",
"description": "Indicates whether to perform a duplication check when you create a payment method.\n\nThe default value is `false`.\n\nWith this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. \n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods\" target=\"_blank\">Duplication check on payment methods</a>.\n"
}
},
"description": "The container for payment method processing options.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
}
],
"example": {
"type": "Betalingsservice",
"bankCode": "345",
"accountKey": "8a90d6128d45df2b018d4b90681c05x0",
"accountNumber": "3179681",
"identityNumber": "0101701234",
"accountHolderInfo": {
"accountHolderName": "TestName"
},
"processingOptions": {
"checkDuplicated": true
}
},
"required": [
"type",
"accountNumber",
"identityNumber",
"bankCode",
"accountHolderInfo"
]
}
CreatePaymentMethodCCReferenceTransaction
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"tokenId": {
"type": "string",
"description": "A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile.\n\nWhen `tokenId` is used to represent a customer profile, `secondTokenId` is conditionally required for representing the underlying tokenized payment method.\n\nThe values for the `tokenId` and `secondTokenId` fields differ for gateways. For more information, see the Knowledge Center article specific to each gateway that supports the CC Reference Transaction payment method.\n"
},
"mandateInfo": {
"properties": {
"mandateId": {
"type": "string",
"maxLength": 36,
"description": "The mandate ID.\n"
},
"mandateReason": {
"type": "string",
"maxLength": 64,
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"maxLength": 64,
"description": "The status of the mandate from the gateway side.\n"
}
},
"description": "The container of the mandate information for the payment method.\n"
},
"secondTokenId": {
"type": "string",
"description": "A gateway unique identifier that replaces sensitive payment method data. \n\n`secondTokenId` is conditionally required only when `tokenId` is being used to represent a gateway customer profile. `secondTokenId` is used in the CC Reference Transaction payment method.\n"
},
"creditCardMaskNumber": {
"type": "string",
"maxLength": 19,
"description": "The masked credit card number, such as `*********1112`.\nThis field is specific for the CC Reference Transaction payment method. It is an optional field that you can use to distinguish different CC Reference Transaction payment methods.\nThough there are no special restrictions on the input string, it is highly recommended to specify a card number that is masked.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
}
],
"example": {
"type": "CreditCardReferenceTransaction",
"tokenId": "A9xCTM0A3D7g0OOiYnwxJMjkZ6Nn8yMDusVbnhvH",
"accountKey": "8a90d6128d45df2b018d4b90681c05x0",
"secondTokenId": "B4D339HPV3KHQQ65",
"creditCardMaskNumber": "************1111"
},
"required": [
"type",
"tokenId"
]
}
CreatePaymentMethodCardholderInfo
{
"type": "object",
"title": "cardHolderInfo",
"example": {
"city": "Redwood City",
"phone": "(888) 976-9056",
"state": "CA",
"country": "USA",
"zipCode": 94065,
"addressLine1": "101 Redwood Shores Parkway",
"cardHolderName": "Amy Lawrence"
},
"required": [
"cardHolderName"
],
"properties": {
"city": {
"type": "string",
"description": "City, 40 characters or less.\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"email": {
"type": "string",
"description": "Card holder's email address, 80 characters or less.\n"
},
"phone": {
"type": "string",
"description": "Phone number, 40 characters or less.\n"
},
"state": {
"type": "string",
"description": "State; must be a valid state name or 2-character abbreviation.\n"
},
"country": {
"type": "string",
"description": "Country, must be a valid country name or abbreviation.\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"zipCode": {
"type": "string",
"description": "Zip code, 20 characters or less.\n"
},
"addressLine1": {
"type": "string",
"description": "First address line, 255 characters or less.\n"
},
"addressLine2": {
"type": "string",
"description": "Second address line, 255 characters or less.\n"
},
"cardHolderName": {
"type": "string",
"description": "The card holder's full name as it appears on the card, e.g., \"John J Smith\", 50 characters or less.\n"
}
},
"description": "Container for cardholder information. The nested `cardHolderName` field is required.\n"
}
CreatePaymentMethodCreditCard
{
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"cardType": {
"type": "string",
"description": "The type of the credit card.\nPossible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).\n"
},
"cardNumber": {
"type": "string",
"description": "Credit card number.\n"
},
"mandateInfo": {
"type": "object",
"properties": {
"mandateId": {
"type": "string",
"maxLength": 36,
"description": "The mandate ID.\n"
},
"mandateReason": {
"type": "string",
"maxLength": 64,
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"maxLength": 64,
"description": "The status of the mandate from the gateway side.\n"
}
},
"description": "The container of the mandate information for the payment method.\n"
},
"securityCode": {
"type": "string",
"description": "CVV or CVV2 security code of the credit card.\n\nTo ensure PCI compliance, this value is not stored and cannot be queried.\n"
},
"cardHolderInfo": {
"$ref": "#/components/schemas/CreatePaymentMethodCardholderInfo"
},
"expirationYear": {
"type": "integer",
"description": "Four-digit expiration year of the credit card.\n"
},
"identityNumber": {
"type": "string",
"description": "The identity number of the cardholder. This field is required for Credit Card payment methods in certain countries such as Brazil.\n"
},
"mitProfileType": {
"enum": [
"Recurring",
"Unscheduled"
],
"type": "string",
"description": "Required if you set the `mitProfileAction` field. Indicates the type of the stored credential profile to process recurring or unsecheduled transactions. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field.\n"
},
"checkDuplicated": {
"type": "boolean",
"description": "Indicates whether the duplication check is performed when you create a new credit card payment method. The default value is `false`.\n\nWith this field set to `true`, Zuora will check all active payment methods associated with the same billing account to ensure that no duplicate credit card payment methods are created. An error is returned if a duplicate payment method is found.\n \nThe following fields are used for the duplication check:\n - `cardHolderName`\n - `expirationMonth`\n - `expirationYear`\n - `creditCardMaskNumber`. It is the masked credit card number generated by Zuora. For example, `************1234`.\n\n**This field is being deprecated.** To achieve the same purpose, use the `processingOptions` > `checkDuplicated` field of the payment method object.\n"
},
"expirationMonth": {
"type": "integer",
"description": "One or two digit expiration month (1-12) of the credit card.\n"
},
"screeningAmount": {
"type": "number",
"format": "decimal",
"description": "For <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Chase_Orbital_Payment_Gateway\" target=\"_blank\">Chase Paymentech Orbital Gateway</a> integrations, if the Safetech Fraud service is enabled, use this field to pass in the amount used for fraud screening for Credit Card validation transactions.\n\nTwo-decimal amount is supported.\n\nIf the `screeningAmount` field is not specified, the authorization amount is used for fraud screening.\n"
},
"mitProfileAction": {
"enum": [
"Activate",
"Persist"
],
"type": "string",
"description": "Specifies how Zuora creates and activates the stored credential profile.\n\n- `Activate` - Use this value if you are creating the stored credential profile after receiving the customer's consent.\n\n Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile.\n \n If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`.\n\n\n- `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`.\n\nIf you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field.\n"
},
"processingOptions": {
"type": "object",
"properties": {
"checkDuplicated": {
"type": "boolean",
"description": "Indicates whether to perform a duplication check when you create a payment method.\n\nThe default value is `false`.\n\nWith this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. \n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods\" target=\"_blank\">Duplication check on payment methods</a>.\n"
}
},
"description": "The container for payment method processing options.\n"
},
"mitProfileAgreedOn": {
"type": "string",
"format": "date",
"description": "The date on which the profile is agreed. The date format is `yyyy-mm-dd`.\n"
},
"mitConsentAgreementRef": {
"type": "string",
"maxLength": 128,
"description": "Specifies your reference for the stored credential consent agreement that you have established with the customer. Only applicable if you set the `mitProfileAction` field.\n"
},
"mitConsentAgreementSrc": {
"enum": [
"External"
],
"type": "string",
"description": "Required if you set the `mitProfileAction` field. Specifies how the consent agreement has been established with the customer. The allowed value is `External`. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field.\n"
},
"mitNetworkTransactionId": {
"type": "string",
"maxLength": 128,
"description": "Specifies the ID of a network transaction. Only applicable if you set the `mitProfileAction` field to `Persist`.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
}
],
"example": {
"type": "CreditCard",
"cardType": "Visa",
"accountKey": "8a90d6128d45df2b018d4b90681c05x0",
"cardNumber": "4111111111111111",
"securityCode": "737",
"cardHolderInfo": {
"cardHolderName": "Amy Lawrence"
},
"expirationYear": "2030",
"mitProfileType": "Recurring",
"expirationMonth": "03",
"mitProfileAction": "Persist",
"processingOptions": {
"checkDuplicated": true
},
"mitProfileAgreedOn": "2024-01-01",
"mitConsentAgreementRef": "TestmitConsentAgreementRef",
"mitConsentAgreementSrc": "External",
"mitNetworkTransactionId": "013067692169266"
},
"required": [
"type",
"cardHolderInfo",
"cardNumber",
"cardType",
"expirationMonth",
"expirationYear"
]
}
CreatePaymentMethodGooglePayAdyen
{
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"email": {
"type": "string",
"description": "Email address associated with the payment method. This field is specific for setting up Google Pay on Adyen v2.0. This field will be passed to Adyen as `shopperEmail`.\n"
},
"googlePaymentToken": {
"type": "string",
"description": "This field is specific for setting up Google Pay for Adyen gateway integrations to specify the stringified Google Pay token. For more information, see [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay).\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
}
],
"example": {
"type": "AdyenGooglePay",
"email": "testemail@test.com",
"accountKey": "2c92c0f97911f46a0179147510484b90",
"googlePaymentToken": "{\"signature\":\"MEUCICeJTEEW+a9ak93yk8pYg4xGlPJbrBNjD8b6vahxD5TRAiEAyMiNhzosJDl2N46Dojzc53bwbT/O0t+VToLCqr01qs4\\u003d\",\"protocolVersion\":\"ECv1\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"aXpc95j3gEFJfaHF8PEpybNuV/k/IDKMa/FkbNnj2p/uaH8ll99hAUwWkH5EnHr2NwNgLuj3j9IhDomWI9gJ4n2fQlsQ9FsNuqsJjct/QuNvlzooLhu76HlzE3mScXcTUqPI1fgC8s/CVNz06aCUd7/oNMzyCw6VploO9abxp3zcpRvAO39bScaO3fri2Kl0WGozyiS0egXcUzMOpPxDw03SjmpgU/X5FjmxayOBUNxM9r/yOQyvY9mTUHOK855XVl3Xf9dpj6GDnDMp4bvCW8zpXWr76Snwtvv41dIaLxNWsBP0lS5PpJ5K1/rSRZg/dauIKQbWGmTTL24vz4Om7hVu25L7XrSM6F2PRUE4rqMblVDvXAlVsD+149r2fjXsB4DXmvGmwaDcuFeTDuI3ov7GDetgW3Fdl+n7RtBOK/luJYs76a9nPbVLhN/aKU5Hpd0ZrIO8ZUOoUYr6WuecD24tTzwic3k921eLJez8IJnG1k05kiqPpHEqMeLyP/WovjH/U7Vu3iDrH4yAxMEuh0MMi0tTgjXlVEezVnsU\\\",\\\"ephemeralPublicKey\\\":\\\"BGNnBpAd6WypQEYJmDH/DhUZ9mX2b/wJK6as8g6hZmDCDpHSWFC1BZ42UBrX/hrF/UarrT24CMcWLZp6fYl6PNw\\\\u003d\\\",\\\"tag\\\":\\\"j9fPmiEL/zj8R+0JRrTC1NgV9VVCYQ9zYaB7uZrEz9U\\\\u003d\\\"}\"}"
},
"required": [
"type",
"googlePaymentToken"
]
}
CreatePaymentMethodGooglePayChase
{
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"googlePaymentToken": {
"type": "string",
"description": "This field is specific for setting up Google Pay on Chase gateway integrations to specify the stringified Google Pay token. For more information, see [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase).\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
}
],
"example": {
"type": "GooglePay",
"accountKey": "2c92c0f97911f46a0179147510484b90",
"googlePaymentToken": "{\"signature\":\"MEUCICeJTEEW+a9ak93yk8pYg4xGlPJbrBNjD8b6vahxD5TRAiEAyMiNhzosJDl2N46Dojzc53bwbT/O0t+VToLCqr01qs4\\u003d\",\"protocolVersion\":\"ECv1\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"aXpc95j3gEFJfaHF8PEpybNuV/k/IDKMa/FkbNnj2p/uaH8ll99hAUwWkH5EnHr2NwNgLuj3j9IhDomWI9gJ4n2fQlsQ9FsNuqsJjct/QuNvlzooLhu76HlzE3mScXcTUqPI1fgC8s/CVNz06aCUd7/oNMzyCw6VploO9abxp3zcpRvAO39bScaO3fri2Kl0WGozyiS0egXcUzMOpPxDw03SjmpgU/X5FjmxayOBUNxM9r/yOQyvY9mTUHOK855XVl3Xf9dpj6GDnDMp4bvCW8zpXWr76Snwtvv41dIaLxNWsBP0lS5PpJ5K1/rSRZg/dauIKQbWGmTTL24vz4Om7hVu25L7XrSM6F2PRUE4rqMblVDvXAlVsD+149r2fjXsB4DXmvGmwaDcuFeTDuI3ov7GDetgW3Fdl+n7RtBOK/luJYs76a9nPbVLhN/aKU5Hpd0ZrIO8ZUOoUYr6WuecD24tTzwic3k921eLJez8IJnG1k05kiqPpHEqMeLyP/WovjH/U7Vu3iDrH4yAxMEuh0MMi0tTgjXlVEezVnsU\\\",\\\"ephemeralPublicKey\\\":\\\"BGNnBpAd6WypQEYJmDH/DhUZ9mX2b/wJK6as8g6hZmDCDpHSWFC1BZ42UBrX/hrF/UarrT24CMcWLZp6fYl6PNw\\\\u003d\\\",\\\"tag\\\":\\\"j9fPmiEL/zj8R+0JRrTC1NgV9VVCYQ9zYaB7uZrEz9U\\\\u003d\\\"}\"}"
},
"required": [
"type",
"googlePaymentToken"
]
}
CreatePaymentMethodPAD
{
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"bankCode": {
"type": "string",
"description": "The sort code or number that identifies the bank. This is also known as the sort code.\n"
},
"branchCode": {
"type": "string",
"description": "The branch code of the bank used for direct debit.\n"
},
"mandateInfo": {
"type": "object",
"properties": {
"mandateId": {
"type": "string",
"maxLength": 36,
"description": "The mandate ID.\n"
},
"mandateReason": {
"type": "string",
"maxLength": 64,
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"maxLength": 64,
"description": "The status of the mandate from the gateway side.\n"
}
},
"description": "The container of the mandate information for the payment method.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer's bank account.\n"
},
"accountHolderInfo": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city where the account holder stays.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"email": {
"type": "string",
"description": "The email address of the account holder.\n"
},
"phone": {
"type": "string",
"description": "The phone number of the account holder.\n"
},
"state": {
"type": "string",
"description": "The state where the account holder stays.\n"
},
"country": {
"type": "string",
"description": "The country where the account holder stays.\n"
},
"zipCode": {
"type": "string",
"description": "The zip code for the address of the account holder.\n"
},
"lastName": {
"type": "string",
"description": "The last name of the account holder.\n"
},
"firstName": {
"type": "string",
"description": "The first name of the account holder.\n"
},
"addressLine1": {
"type": "string",
"description": "The first line of the address for the account holder.\n"
},
"addressLine2": {
"type": "string",
"description": "The second line of the address for the account holder. \n"
},
"accountHolderName": {
"type": "string",
"maxLength": 60,
"description": "Required.\n\nThe full name of the bank account holder.\n"
}
},
"description": "The container for the account holder information. The nested `accountHolderName` field is required.\n"
},
"accountMaskNumber": {
"type": "string",
"description": "The masked account number such as ****1234.\n"
},
"processingOptions": {
"type": "object",
"properties": {
"checkDuplicated": {
"type": "boolean",
"description": "Indicates whether to perform a duplication check when you create a payment method.\n\nThe default value is `false`.\n\nWith this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. \n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods\" target=\"_blank\">Duplication check on payment methods</a>.\n"
}
},
"description": "The container for payment method processing options.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
}
],
"example": {
"type": "PAD",
"bankCode": "0003",
"accountKey": "8a90d6128d45df2b018d4b90681c05x0",
"branchCode": "00006",
"accountNumber": "0000000",
"accountHolderInfo": {
"accountHolderName": "TestName"
},
"processingOptions": {
"checkDuplicated": true
}
},
"required": [
"type",
"accountNumber",
"bankCode",
"branchCode",
"accountHolderInfo"
]
}
CreatePaymentMethodPayPalAdaptive
{
"allOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"email": {
"type": "string",
"format": "email",
"description": "Email address associated with the payment method.\n"
},
"preapprovalKey": {
"type": "string",
"description": "The PayPal preapproval key.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
}
],
"example": {
"type": "PayPalAdaptive",
"email": "customer@example.com",
"accountKey": "8a90d6128d45df2b018d4b90681c05x0",
"preapprovalKey": "PA-3X000000LS390262X"
},
"required": [
"type",
"preapprovalKey",
"email"
]
}
CreatePaymentMethodSEPA
{
"allOf": [
{
"type": "object",
"properties": {
"IBAN": {
"type": "string",
"description": "The International Bank Account Number. \n\nThis field is required if the `type` field is set to `SEPA`. However, for creating tokenized SEPA payment methods on Adyen Integration v2.0, this field is optional. \n - If the `tokenize` field is `true`, `IBAN` is required. \n - If the `tokens` field is specified, `IBAN` is not required but `accountMaskNumber` is required.\n"
},
"type": {
"type": "string"
},
"tokens": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"description": "Required. \n\nPass in the first token of the payment method. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Adyen_Integration_v2.0/D_Tokenize_SEPA_payment_methods_on_Adyen_Integration_v2.0\" target=\"_blank\">Tokenize SEPA payment methods on Adyen Integration v2.0</a>.\n"
},
"gatewayType": {
"enum": [
"Adyen"
],
"type": "string",
"description": "Required. \n\nThe type of the payment gateway to generate the tokens. This field is case-sensitive.\n"
},
"thirdTokenId": {
"type": "string",
"description": "Pass in the third token of the payment method.\n"
},
"secondTokenId": {
"type": "string",
"description": "Pass in the second token of the payment method. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Adyen_Integration_v2.0/D_Tokenize_SEPA_payment_methods_on_Adyen_Integration_v2.0\" target=\"_blank\">Tokenize SEPA payment methods on Adyen Integration v2.0</a>.\n"
}
},
"description": "To create tokenized SEPA payment methods on Adyen Integration v2.0, pass in the existing token information through the fields in this container.\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Adyen_Integration_v2.0/D_Tokenize_SEPA_payment_methods_on_Adyen_Integration_v2.0\" target=\"_blank\">Tokenize SEPA payment methods on Adyen Integration v2.0</a>.\n"
},
"tokenize": {
"type": "boolean",
"default": false,
"description": "When creating a SEPA payment method on Adyen Integration v2.0, use this\nfield to specify whether to tokenize the payment method with IBAN. If\n`tokenize` is `true`, `IBAN` is required. If the `tokens` field is provided, this `tokenize` field is not required. For more information about how to create tokenized SEPA payment methods on\nAdyen, see <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Adyen_Integration_v2.0/D_Tokenize_SEPA_payment_methods_on_Adyen_Integration_v2.0\"\ntarget=\"_blank\">Tokenize SEPA payment methods on Adyen Integration\nv2.0</a>.\n"
},
"mandateInfo": {
"type": "object",
"properties": {
"mandateId": {
"type": "string",
"maxLength": 36,
"description": "The mandate ID.\n"
},
"mandateReason": {
"type": "string",
"maxLength": 64,
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"maxLength": 64,
"description": "The status of the mandate from the gateway side.\n"
}
},
"description": "The container of the mandate information for the payment method.\n"
},
"accountHolderInfo": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city where the account holder stays.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"email": {
"type": "string",
"description": "The email address of the account holder.\n"
},
"phone": {
"type": "string",
"description": "The phone number of the account holder.\n"
},
"state": {
"type": "string",
"description": "The state where the account holder stays.\n"
},
"country": {
"type": "string",
"description": "The country where the account holder stays.\n\nThis field is required for SEPA payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).\n"
},
"zipCode": {
"type": "string",
"description": "The zip code for the address of the account holder.\n"
},
"lastName": {
"type": "string",
"description": "The last name of the account holder.\n"
},
"firstName": {
"type": "string",
"description": "The first name of the account holder.\n"
},
"addressLine1": {
"type": "string",
"description": "The first line of the address for the account holder.\n\nThis field is required for SEPA Direct Debit payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).\n"
},
"addressLine2": {
"type": "string",
"description": "The second line of the address for the account holder. \n"
},
"accountHolderName": {
"type": "string",
"maxLength": 60,
"description": "Required.\n\nThe full name of the bank account holder.\n"
}
},
"description": "The container for the account holder information. The nested `accountHolderName` field is required.\n"
},
"accountMaskNumber": {
"type": "string",
"description": "The masked account number such as ****1234.\nWhen creating SEPA payment methods on Adyen, if the `tokens` field is provided, this `accountMaskNumber` field is required. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Adyen_Integration_v2.0/D_Tokenize_SEPA_payment_methods_on_Adyen_Integration_v2.0\" target=\"_blank\">Tokenize SEPA payment methods on Adyen Integration v2.0</a>\n"
},
"processingOptions": {
"type": "object",
"properties": {
"checkDuplicated": {
"type": "boolean",
"description": "Indicates whether to perform a duplication check when you create a payment method.\n\nThe default value is `false`.\n\nWith this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. \n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods\" target=\"_blank\">Duplication check on payment methods</a>.\n"
}
},
"description": "The container for payment method processing options.\n"
},
"businessIdentificationCode": {
"type": "string",
"description": "The BIC code used for SEPA.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodCommonFields"
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
}
],
"example": {
"IBAN": "FR1420041010050500013M02606",
"type": "SEPA",
"accountKey": "8a90d6128d45df2b018d4b90681c05x0",
"accountHolderInfo": {
"accountHolderName": "TestName"
},
"processingOptions": {
"checkDuplicated": true
}
},
"required": [
"type",
"IBAN",
"accountHolderInfo"
]
}
CreatePaymentType
{
"allOf": [
{
"type": "object",
"required": [
"amount",
"currency",
"type"
],
"properties": {
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the payment.\n\n**Note**: If you specify the type as `Electronic`, you must specify the value for `accountId` or `accountNumber`.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment.\n"
},
"comment": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "Additional information related to the payment.\n"
},
"currency": {
"type": "string",
"description": "When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI. But if you have the [Multiple Currencies](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies) feature enabled, you can have a different payment currency.\n\nWhen Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.\n"
},
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentInvoiceApplicationCreateRequestType"
},
"description": "Container for invoices. The maximum number of invoices is 1,000.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account that the payment is created for.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the payment. The ID must be a valid gateway instance ID and this gateway must support the specific payment method.\n\n- If <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Payment_Gateway_Routing\" target=\"_blank\">Payment Gateway Routing</a> is enabled, when creating electronic payments, this field is optional. \n - If this field is not specified, gateway routing rules will be invoked.\n - If this field is specified, the specified gateway will be used to process the payment.\n\n- If Payment Gateway Routing is disabled, when creating electronic payments, this field is required.\n\n- When creating external payments, this field is optional.\n\nUse the same gateway instance if both `paymentGatewayNumber` and\n`gatewayId` are sent in the request.\n"
},
"debitMemos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentDebitMemoApplicationCreateRequestType"
},
"description": "Container for debit memos. The maximum number of debit memos is 1,000.\n"
},
"prepayment": {
"type": "boolean",
"description": "Indicates whether the payment will be used as a reserved payment. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.\n"
},
"standalone": {
"type": "boolean",
"default": false,
"description": "This field is only available if support for standalone payments is enabled.\n\nSpecify `true` to create a standalone payment that will be processed in Zuora through Zuora gateway integration but will be settled outside of Zuora.\n\nWhen `standalone` is set to `true`:\n - `accountId`, `amount`, `currency`, and `type` are required. \n - `type` must be `Electronic`.\n - `currency` of the payment can be different from the payment currency in the customer account settings.\n - The amount will not be summed up into the account balance and key metrics regardless of the payment currency.\n - No settlement data will be created.\n - Either the applied amount or the unapplied amount of the payment is zero.\n - The standalone payment cannot be applied, unapplied, or transferred.\n\nSpecify `false` to create an ordinary payment that will be created, processed, and settled in Zuora. The `currency` of an ordinary payment must be the same as the currency in the customer account settings.\n"
},
"customRates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentWithCustomRatesType"
},
"maxItems": 2,
"description": "It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both).\n\n**Note**: The API custom rate feature is permission controlled.\n"
},
"referenceId": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account that the payment is created for, such as `A00000001`.\n\nYou can specify either `accountNumber` or `accountId` for a customer account. If both of them are specified, they must refer to the same customer account.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the payment takes effect, in `yyyy-mm-dd` format.\n\n**Note:**\n - This field is required for only electronic payments. It's an optional field for external payments.\n - When specified, this field must be set to the date of today.\n - When applying or transferring payments, this field must be later than or equal to the maximum effective date of the payment.\n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\nHere is an example:\n```\n\"paymentOption\": [\n {\n \"type\": \"GatewayOptions\",\n \"detail\": {\n \"SecCode\":\"WEB\"\n }\n }\n]\n```\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n\nYou can use this field or the `gatewayOptions` field to pass the Gateway Options fields supported by a payment gateway. However, the Gateway Options fields passed through the `paymentOption` field will be stored in the Payment Option object and can be easily retrieved.\n"
},
"gatewayOptions": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255,
"description": "The name of a gateway-specific parameter.\n"
},
"value": {
"type": "string",
"maxLength": 255,
"description": "The value of the gateway-specific parameter.\n"
}
},
"description": "The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).\n\nZuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.\n"
},
"gatewayOrderId": {
"type": "string",
"maxLength": 50,
"description": "A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead.\n\nGateways check duplicates on the gateway order ID to ensure that the merchant do not accidentally enter the same transaction twice. This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use their shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems.\n\nWhen you create a payment for capturing the authorized funds, it is highly recommended to pass in the gatewayOrderId that you used when authorizing the funds by using the [Create authorization](https://www.zuora.com/developer/api-references/api/operation/POST_CreateAuthorization) operation, together with the `authTransactionId` field.\n"
},
"softDescriptor": {
"type": "string",
"maxLength": 35,
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi."
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the payment. \n\nIf no payment method ID is specified in the request body, the default payment method for the customer account is used automatically. If the default payment method is different from the type of payments that you want to create, an error occurs.\n"
},
"authTransactionId": {
"type": "string",
"maxLength": 50,
"description": "The authorization transaction ID from the payment gateway. Use this field for electronic payments, such as credit cards.\n\nWhen you create a payment for capturing the authorized funds, it is highly recommended to pass in the gatewayOrderId that you used when authorizing the funds by using the [Create authorization](https://www.zuora.com/developer/api-references/api/operation/POST_CreateAuthorization) operation, together with the `authTransactionId` field.\n\nThe following payment gateways support this field:\n - Adyen Integration v2.0\n - CyberSource 1.28\n - CyberSource 1.97\n - CyberSource 2.0\n - Chase Paymentech Orbital\n - Ingenico ePayments\n - SlimPay\n - Stripe v2\n - Verifi Global Payment Gateway\n - WePay Payment Gateway Integration\n"
},
"paymentMethodType": {
"type": "string",
"default": null,
"description": "The type of the payment method that the customer used to make the payment. \n\nSpecify this value when you are creating an external payment method. If both `paymentMethodType` and `paymentMethodId` are specified, only the `paymentMethodId` value is used to create the payment.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the unapplied payment.\n"
}
},
"description": "Container for the finance information related to the payment.\n"
},
"paymentScheduleKey": {
"type": "string",
"description": "The unique ID or the number of the payment schedule to be linked with the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information."
},
"softDescriptorPhone": {
"type": "string",
"maxLength": 20,
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi."
},
"mitTransactionSource": {
"enum": [
"C_Unscheduled",
"M_Recurring",
"M_Unscheduled",
"M_MOTO"
],
"type": "string",
"description": "Payment transaction source used to differentiate the transaction source in Stored Credential Transaction framework.\n - `C_Unscheduled`: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates.\n - `M_Recurring`: Merchant-initiated transaction (MIT) that occurs at regular intervals.\n - `M_Unscheduled`: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates.\n - `M_MOTO`: Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See [Overview of Stripe payment gateway integration](https://knowledgecenter.zuora.com/Zuora_Collect/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration) for more information.\n"
},
"paymentGatewayNumber": {
"type": "string",
"description": "The natural key for the payment gateway. \n\nUse the same gateway instance if both `paymentGatewayNumber` and `gatewayId` are sent in the request.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentObjectNSFields"
},
{
"$ref": "#/components/schemas/PaymentObjectCustomFields"
}
],
"example": {
"type": "External",
"amount": 44.1,
"comment": "normal payment",
"currency": "USD",
"invoices": [
{
"items": [
{
"amount": 39,
"invoiceItemId": "4028905f5a87c0ff015a87d3f90c0045"
},
{
"amount": 1,
"taxItemId": "4028905f5a87c0ff015a87d3f884003f"
}
],
"amount": 40,
"invoiceId": "4028905f5a87c0ff015a87d3f8f10043"
}
],
"accountId": "4028905f5a87c0ff015a87d25ae90025",
"debitMemos": [
{
"items": [
{
"amount": 4,
"debitMemoItemId": "4028905f5a87c0ff015a87e49e7a0063"
},
{
"amount": 0.1,
"taxItemId": "4028905f5a87c0ff015a87e49f5e0065"
}
],
"amount": 4.1,
"debitMemoId": "4028905f5a87c0ff015a87e49e6b0062"
}
],
"customRates": [
{
"currency": "CAD",
"rateDate": "2022-10-21",
"customFxRate": 2.22
},
{
"currency": "EUR",
"rateDate": "2022-10-21",
"customFxRate": 1.5
}
],
"effectiveDate": "2017-03-01",
"paymentMethodId": "402881e522cf4f9b0122cf5dc4020045"
}
}
CreateStoredCredentialProfileRequest
{
"type": "object",
"example": {
"type": "Recurring",
"status": "Active",
"authGateway": "4028905f5702783601570291e14c0015",
"consentAgreementRef": "ACCT1338AgreementV1.pdf",
"consentAgreementSrc": "External"
},
"required": [
"status",
"type",
"consentAgreementSrc"
],
"properties": {
"type": {
"enum": [
"Recurring",
"Unscheduled"
],
"type": "string",
"description": "Indicates the type of the stored credential profile to process recurring or unsecheduled transactions.\n"
},
"action": {
"enum": [
"Activate",
"Persist"
],
"type": "string",
"description": "Specifies how Zuora activates the stored credential profile. Only applicable if you set the `status` field to `Active`.\n\n- `Activate` (default) - Use this value if you are creating the stored credential profile after receiving the customer's consent.\n\n Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile.\n \n If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`.\n\n\n- `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`.\n"
},
"status": {
"enum": [
"Agreed",
"Active"
],
"type": "string",
"description": "Specifies the status of the stored credential profile.\n\n- `Active` - Use this value if you are creating the stored credential profile after receiving the customer's consent, or if the stored credential profile represents a stored credential profile in an external system.\n\n You can use the `action` field to specify how Zuora activates the stored credential profile.\n\n\n- `Agreed` - Use this value if you are migrating the payment method to the stored credential transaction framework.\n\n In this case, Zuora will not send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile.\n"
},
"agreedOn": {
"type": "string",
"format": "date",
"description": "The date on which the profile is agreed. The date format is `yyyy-mm-dd`.\n"
},
"authGateway": {
"type": "string",
"description": "Specifies the ID of the payment gateway that Zuora will use when activating the stored credential profile.\n"
},
"cardSecurityCode": {
"type": "string",
"description": "The security code of the credit card.\n"
},
"consentAgreementRef": {
"type": "string",
"maxLength": 128,
"description": "Specifies your reference for the consent agreement that you have established with the customer.\n"
},
"consentAgreementSrc": {
"enum": [
"External"
],
"type": "string",
"description": "Specifies how the consent agreement has been established with the customer. The allowed value is `External`.\n"
},
"networkTransactionId": {
"type": "string",
"maxLength": 128,
"description": "The ID of a network transaction. Only applicable if you set the `action` field to `Persist`.\n"
}
}
}
CreateSubscription
{
"type": "object",
"title": "createSubscription",
"properties": {
"notes": {
"type": "string",
"maxLength": 500,
"description": "Notes about the subscription. These notes are only visible to Zuora users.\n"
},
"terms": {
"type": "object",
"required": [
"initialTerm",
"renewalTerms"
],
"properties": {
"autoRenew": {
"type": "boolean",
"description": "Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is `TERMED`.\n"
},
"initialTerm": {
"type": "object",
"required": [
"termType"
],
"properties": {
"period": {
"type": "integer",
"description": "Duration of the first term in months, years, days, or weeks, depending on the value of the `periodType` field. Only applicable if the value of the `termType` field is `TERMED`.\n"
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN"
],
"type": "string",
"description": "Type of the first term. If the value of this field is `TERMED`, the first term has a predefined duration based on the value of the `period` field. If the value of this field is `EVERGREEN`, the first term does not have a predefined duration.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "Start date of the first term, in YYYY-MM-DD format.\n"
},
"periodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"description": "Unit of time that the first term is measured in. Only applicable if the value of the `termType` field is `TERMED`.\n"
}
},
"description": "Information about the first term of the subscription.\n"
},
"renewalTerms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RenewalTerm"
},
"description": "List of renewal terms of the subscription. Only applicable if the type of the first term is `TERMED` and the value of the `renewalSetting` field is `RENEW_WITH_SPECIFIC_TERM`.\n"
},
"renewalSetting": {
"enum": [
"RENEW_WITH_SPECIFIC_TERM",
"RENEW_TO_EVERGREEN"
],
"type": "string",
"description": "Specifies the type of the terms that follow the first term if the subscription is renewed. Only applicable if the type of the first term is `TERMED`.\n\n* `RENEW_WITH_SPECIFIC_TERM` - Each renewal term has a predefined duration. The first entry in `renewalTerms` specifies the duration of the second term of the subscription, the second entry in `renewalTerms` specifies the duration of the third term of the subscription, and so on. The last entry in `renewalTerms` specifies the ultimate duration of each renewal term.\n* `RENEW_TO_EVERGREEN` - The second term of the subscription does not have a predefined duration.\n"
}
},
"description": "Container for the terms and renewal settings of the subscription.\n"
},
"currency": {
"type": "string",
"maxLength": 3,
"description": "The code of currency that is used for this subscription. If the currency is not selected, the default currency from the account will be used.\n\nAll subscriptions in the same order must use the same currency. The currency for a subscription cannot be changed.\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currencies</a> feature enabled.\n"
},
"paymentTerm": {
"type": "string",
"description": "The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceSeparately": {
"type": "boolean",
"description": "Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"maxLength": 255,
"description": "The number of the invoice group associated with the subscription.\n\nAfter enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"subscriptionNumber": {
"type": "string",
"maxLength": 100,
"description": "Subscription number of the subscription. For example, A-S00000001.\n\nIf you do not set this field, Zuora will generate the subscription number.\n"
},
"subscribeToRatePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RatePlanOverride"
},
"description": "List of rate plans associated with the subscription.\n"
},
"newSubscriptionOwnerAccount": {
"type": "object",
"required": [
"name",
"currency",
"billCycleDay",
"billToContact"
],
"properties": {
"name": {
"type": "string",
"maxLength": 70,
"description": "Account name.\n"
},
"batch": {
"type": "string",
"description": "Name of the billing batch that the account belongs to. For example, Batch1.\n"
},
"crmId": {
"type": "string",
"maxLength": 100,
"description": "External identifier of the account in a CRM system.\n"
},
"notes": {
"type": "string",
"maxLength": 65535,
"description": "Notes about the account. These notes are only visible to Zuora users.\n"
},
"autoPay": {
"type": "boolean",
"description": "Specifies whether future payments are automatically billed when they are due.\n"
},
"taxInfo": {
"$ref": "#/components/schemas/TaxInfo"
},
"currency": {
"type": "string",
"description": "ISO 3-letter currency code (uppercase). For example, USD.\n"
},
"parentId": {
"type": "string",
"description": "Identifier of the parent customer account for this Account object. Use this field if you have <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\" target=\"_blank\">Customer Hierarchy</a> enabled."
},
"creditCard": {
"$ref": "#/components/schemas/creditCard"
},
"paymentTerm": {
"type": "string",
"description": "Name of the payment term associated with the account. For example, \"Net 30\". The payment term determines the due dates of invoices.\n"
},
"billCycleDay": {
"type": "integer",
"maximum": 31,
"minimum": 0,
"description": "Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\".\n"
},
"customFields": {
"$ref": "#/components/schemas/AccountObjectCustomFields"
},
"accountNumber": {
"type": "string",
"maxLength": 70,
"description": "Account number. For example, A00000001.\n"
},
"billToContact": {
"$ref": "#/components/schemas/BillToContact"
},
"paymentMethod": {
"$ref": "#/components/schemas/POSTPaymentMethodRequest"
},
"soldToContact": {
"$ref": "#/components/schemas/SoldToContact"
},
"paymentGateway": {
"type": "string",
"maxLength": 40,
"description": "The payment gateway that Zuora uses when processing electronic payments and refunds for the account. If you do not specify this field or if the value of this field is null, Zuora uses your default payment gateway.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "Internal identifier of the invoice template that Zuora uses when generating invoices for the account.\n"
},
"communicationProfileId": {
"type": "string",
"description": "Internal identifier of the communication profile that Zuora uses when sending notifications to the account's contacts.\n"
},
"invoiceDeliveryPrefsEmail": {
"type": "boolean",
"description": "Specifies whether to turn on the invoice delivery method 'Email' for the new account. \nValues are: \n\n* `true` (default). Turn on the invoice delivery method 'Email' for the new account.\n* `false`. Turn off the invoice delivery method 'Email' for the new account. \n"
},
"invoiceDeliveryPrefsPrint": {
"type": "boolean",
"description": "Specifies whether to turn on the invoice delivery method 'Print' for the new account.\nValues are: \n\n* `true`. Turn on the invoice delivery method 'Print' for the new account.\n* `false` (default). Turn off the invoice delivery method 'Print' for the new account.\n"
},
"hpmCreditCardPaymentMethodId": {
"type": "string",
"description": "The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.\n\nIf the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field,\nbut not both.\n\nFor the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the `paymentMethod` field to create a CC Reference Transaction payment method for an account.\n"
}
},
"description": "Information about a new account that will own the subscription. Only available if you have enabled the Owner Transfer feature.\n\n**Note:** The Owner Transfer 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\nIf you do not set this field or the `subscriptionOwnerAccountNumber` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `subscriptionOwnerAccountNumber` field.\n"
},
"subscriptionOwnerAccountNumber": {
"type": "string",
"maxLength": 70,
"description": "Account number of an existing account that will own the subscription. For example, A00000001.\n\nIf you do not set this field or the `newSubscriptionOwnerAccount` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `newSubscriptionOwnerAccount` field.\n"
}
},
"description": "Information about an order action of type `CreateSubscription`.\n"
}
CreateTemplateRequestContent
{
"type": "object",
"title": "CreateTemplateRequestContent",
"required": [
"description",
"name",
"templateTenant"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the Template."
},
"content": {
"$ref": "#/components/schemas/SettingSourceComponentResponse"
},
"settings": {
"type": "boolean",
"description": "Selected Settings component or not."
},
"workflows": {
"type": "boolean",
"description": "Selected Workflow component or not."
},
"description": {
"type": "string",
"description": "Creates template description."
},
"customFields": {
"type": "boolean",
"description": "Selected custom fields component or not."
},
"customObjects": {
"type": "boolean",
"description": "Selected custom objects component or not."
},
"notifications": {
"type": "boolean",
"description": "Selected Notification component or not."
},
"templateTenant": {
"type": "string",
"example": "80b3f8cd-5801-4ed7-bee7-ad1569916c2f",
"description": "ID of the template tenant."
},
"selectedComponents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigurationTemplateContent"
},
"description": "ConfigurationTemplateContent object contains the selected meta data information."
}
},
"description": "CreateTemplateRequestContent object contains information for creating template.\n"
}
CreditMemoApplyDebitMemoItemRequestType
{
"type": "object",
"title": "items",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount that is applied to the specific item. \n"
},
"taxItemId": {
"type": "string",
"description": "The ID of the debit memo taxation item that the credit memo taxation item is applied to.\n"
},
"creditTaxItemId": {
"type": "string",
"description": "The ID of the credit memo taxation item.\n"
},
"debitMemoItemId": {
"type": "string",
"description": "The ID of the debit memo item that the credit memo item is applied to.\n"
},
"creditMemoItemId": {
"type": "string",
"description": "The ID of the credit memo item.\n"
}
}
}
CreditMemoApplyDebitMemoRequestType
{
"type": "object",
"title": "debitMemos",
"required": [
"amount",
"debitMemoId"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoApplyDebitMemoItemRequestType"
},
"description": "Container for items. The maximum number of items is 1,000.\n\nIf `creditMemoItemId` is the source, then it should be accompanied by a target `debitMemoItemId`.\n\nIf `creditTaxItemId` is the source, then it should be accompanied by a target `taxItemId`.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The credit memo amount to be applied to the debit memo.\n"
},
"debitMemoId": {
"type": "string",
"description": "The unique ID of the debit memo that the credit memo is applied to.\n"
}
}
}
CreditMemoApplyInvoiceItemRequestType
{
"type": "object",
"title": "items",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount that is applied to the specific item. \n"
},
"taxItemId": {
"type": "string",
"description": "The ID of the invoice taxation item that the credit memo taxation item is applied to.\n"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the invoice item that the credit memo item is applied to.\n"
},
"creditTaxItemId": {
"type": "string",
"description": "The ID of the credit memo taxation item.\n"
},
"creditMemoItemId": {
"type": "string",
"description": "The ID of the credit memo item.\n"
}
}
}
CreditMemoApplyInvoiceRequestType
{
"type": "object",
"title": "invoices",
"required": [
"amount",
"invoiceId"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoApplyInvoiceItemRequestType"
},
"description": "Container for items. The maximum number of items is 1,000.\n\nIf `creditMemoItemId` is the source, then it should be accompanied by a target `invoiceItemId`.\n\nIf `creditTaxItemId` is the source, then it should be accompanied by a target `taxItemId`.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The credit memo amount to be applied to the invoice.\n"
},
"invoiceId": {
"type": "string",
"description": "The unique ID of the invoice that the credit memo is applied to.\n"
}
}
}
CreditMemoEntityPrefix
{
"type": "object",
"title": "creditMemo",
"properties": {
"prefix": {
"type": "string",
"example": "CM",
"description": "The prefix of credit memos.\n"
},
"startNumber": {
"type": "integer",
"example": 10,
"description": "The starting document number of credit memos.\n"
}
},
"description": "Container for the prefix and starting document number of credit memos.\n\n**Note:** This field is only available if you have the Invoice Settlement feature 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
}
CreditMemoFile
{
"type": "object",
"title": "creditMemoFile",
"properties": {
"id": {
"type": "string",
"description": "The ID of the credit memo PDF file. This is the ID for the file object and different from the file handle ID in the `pdfFileUrl` field. To open a file, you have to use the file handle ID.\n"
},
"pdfFileUrl": {
"type": "string",
"description": "The REST URL for the credit memo PDF file. Click the URL to open the credit memo PDF file.\n"
},
"versionNumber": {
"type": "integer",
"format": "int64",
"description": "The version number of the credit memo PDF file.\n"
}
}
}
CreditMemoFromChargeCustomRatesType
{
"allOf": [
{
"type": "object",
"required": [
"currency",
"customFxRate"
],
"properties": {
"currency": {
"type": "string",
"description": "The currency code for either Reporting or Home currency.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"rateDate": {
"type": "string",
"format": "date",
"description": "The date on which a particular currency rate is fixed or obtained on.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"customFxRate": {
"type": "number",
"format": "decimal",
"description": "The Custom FX conversion rate between Home/Reporting and Transactional currency items.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
}
}
},
{
"$ref": "#/components/schemas/CreditMemoItemObjectCustomFields"
}
],
"title": "customRates"
}
CreditMemoFromChargeDetailType
{
"allOf": [
{
"type": "object",
"required": [
"chargeId",
"productRatePlanChargeId"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the credit memo item.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"comment": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "Comments about the product rate plan charge.\n\n**Note**: This field is not available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"chargeId": {
"type": "string",
"description": "The ID of the product rate plan charge that the credit memo is created from.\n\n**Note**: This field is not available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "The number of units for the credit memo item.\n"
},
"description": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "The description of the product rate plan charge.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"memoItemAmount": {
"type": "number",
"format": "double",
"description": "The amount of the credit memo item.\n\n**Note**: This field is not available if you set the `zuora-version` request header to `224.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The service end date of the credit memo item. If not specified, the effective end date of the corresponding product rate plan will be used.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The service start date of the credit memo item. If not specified, the effective start date of the corresponding product rate plan will be used.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"onAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n"
}
},
"description": "Container for the finance information related to the product rate plan charge associated with the credit memo.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of the product rate plan charge that the credit memo is created from.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude the credit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.\n"
}
}
},
{
"$ref": "#/components/schemas/CreditMemoItemObjectCustomFields"
}
],
"title": "charges"
}
CreditMemoFromChargeRequest
{
"allOf": [
{
"type": "object",
"properties": {
"charges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoFromChargeDetailType"
},
"maxItems": 1000,
"description": "Container for product rate plan charges. The maximum number of items is 1,000.\n"
},
"comment": {
"type": "string",
"description": "Comments about the credit memo.\n"
},
"autoPost": {
"type": "boolean",
"default": false,
"description": "Whether to automatically post the credit memo after it is created. \n\nSetting this field to `true`, you do not need to separately call the [Post a credit memo](https://developer.zuora.com/api-references/api/operation/PUT_PostCreditMemo) operation to post the credit memo.\n"
},
"currency": {
"type": "string",
"description": "The code of a currency as defined in Billing Settings through the Zuora UI.\n\nIf you do not specify a currency during credit memo creation, the default account currency is applied. The currency that you specify in the request must be configured and activated in Billing Settings.\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currencies</a> feature enabled.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with the credit memo.\n\n**Note**: When creating credit memos from product rate plan charges, you must specify `accountNumber`, `accountId`, or both in the request body. If both fields are specified, they must correspond to the same account.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n"
},
"customRates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoFromChargeCustomRatesType"
},
"maxItems": 2,
"description": "It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both).\n\n**Note**: The API custom rate feature is permission controlled.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account associated with the credit memo.\n\n**Note**: When creating credit memos from product rate plan charges, you must specify `accountNumber`, `accountId`, or both in the request body. If both fields are specified, they must correspond to the same account.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the credit memo takes effect.\n"
},
"excludeFromAutoApplyRules": {
"type": "boolean",
"default": false,
"description": "Whether the credit memo is excluded from the rule of automatically applying unapplied credit memos to invoices and debit memos during payment runs. If you set this field to `true`, a payment run does not pick up this credit memo or apply it to other invoices or debit memos.\n"
}
}
},
{
"$ref": "#/components/schemas/CreditMemoObjectNSFields"
},
{
"$ref": "#/components/schemas/CreditMemoObjectCustomFields"
}
],
"title": "memos",
"example": {
"charges": [
{
"amount": null,
"comment": "this is comment1",
"chargeId": "402890555a87d7f5015a88c613c5001e",
"quantity": 1,
"serviceEndDate": "2018-10-17",
"serviceStartDate": "2017-10-17"
},
{
"amount": 20,
"comment": "this is comment2",
"chargeId": "402890555a7d4022015a7d90906b0067",
"serviceEndDate": "2018-10-17",
"serviceStartDate": "2017-10-17"
}
],
"comment": "the comment",
"autoPost": false,
"currency": "USD",
"accountId": "402890555a7e9791015a7f15fe44001c",
"reasonCode": "Correcting invoice error",
"customRates": [
{
"currency": "CAD",
"rateDate": "2022-10-21",
"customFxRate": 2.22
},
{
"currency": "EUR",
"rateDate": "2022-10-21",
"customFxRate": 2.22
}
],
"effectiveDate": "2017-10-17",
"excludeFromAutoApplyRules": true
}
}
CreditMemoFromInvoiceRequest
{
"allOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoItemFromInvoiceItemType"
},
"maxItems": 1000,
"description": "Container for items. The maximum number of items is 1,000.\n"
},
"comment": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "Comments about the credit memo.\n"
},
"autoPost": {
"type": "boolean",
"default": false,
"description": "Whether to automatically post the credit memo after it is created. \nSetting this field to `true`, you do not need to separately call the [Post credit memo](https://developer.zuora.com/api-references/api/operation/PUT_PostCreditMemo) operation to post the credit memo.\n"
},
"invoiceId": {
"type": "string",
"description": "The ID of the invoice that the credit memo is created from.\n* If this field is specified, its value must be the same as the value of the `invoiceId` path parameter. Otherwise, its value overrides the value of the `invoiceId` path parameter. \n* If this field is not specified, the value of the `invoiceId` path parameter is used.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the credit memo takes effect.\n"
},
"taxAutoCalculation": {
"type": "boolean",
"default": true,
"description": "Whether to automatically calculate taxes in the credit memo.\n"
},
"excludeFromAutoApplyRules": {
"type": "boolean",
"description": "Whether the credit memo is excluded from the rule of automatically applying credit memos to invoices.\n"
},
"autoApplyToInvoiceUponPosting": {
"type": "boolean",
"description": "Whether the credit memo automatically applies to the invoice upon posting.\n"
}
}
},
{
"$ref": "#/components/schemas/CreditMemoObjectNSFields"
},
{
"$ref": "#/components/schemas/CreditMemoObjectCustomFields"
}
],
"title": "memos",
"example": {
"items": [
{
"amount": 1,
"comment": "This is comment!",
"skuName": "SKU-30",
"taxMode": "TaxExclusive",
"quantity": 1,
"taxItems": [
{
"amount": 0.01,
"taxCode": null,
"taxDate": "2016-11-30",
"taxName": "STATE TAX",
"taxRate": 0.0625,
"taxRateType": "Percentage",
"jurisdiction": "CALIFORNIA",
"locationCode": "06",
"sourceTaxItemId": "4028905558b483220158b48983150010",
"taxExemptAmount": 0,
"taxCodeDescription": "This is tax code description!",
"taxRateDescription": "This is tax rate description!"
}
],
"invoiceItemId": "4028905558b483220158b48983dd0015",
"unitOfMeasure": "Test_UOM",
"serviceEndDate": "2016-11-30",
"serviceStartDate": "2016-11-01"
}
],
"comment": "the comment",
"autoPost": false,
"reasonCode": "Write-off",
"effectiveDate": "2016-11-30",
"excludeFromAutoApplyRules": false,
"autoApplyToInvoiceUponPosting": false
}
}
CreditMemoItemFromInvoiceItemType
{
"allOf": [
{
"type": "object",
"required": [
"skuName",
"amount",
"invoiceItemId"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the credit memo item.\n"
},
"comment": {
"type": "string",
"description": "Comments about the credit memo item.\n**Note**: This field is not available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"skuName": {
"type": "string",
"description": "The name of the charge associated with the invoice.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive"
],
"type": "string",
"default": "TaxExclusive",
"description": "The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax.\n**Note**: \n - Only includes the `taxMode` field if the credit memo needs to be processed with a different tax mode than what was processed during invoice generation or the product rate plan charge was defined with. Otherwise, do not specify a tax mode.\n - You can set this field to `TaxInclusive` only if the `taxAutoCalculation` field is set to `true`.\n - If you set `taxMode` to `TaxInclusive`, you cannot input tax amounts for credit memo items. The corresponding invoice item must use the same tax engine as the credit memo item to calculate tax amounts.\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "The number of units for the credit memo item.\n"
},
"taxItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoTaxItemFromInvoiceTaxItemType"
},
"description": "Container for taxation items.\n"
},
"description": {
"type": "string",
"description": "The description of the credit memo item.\n**Note**: This field is only available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the invoice item.\n"
},
"unitOfMeasure": {
"type": "string",
"description": "The definable unit that you measure when determining charges.\n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The service end date of the credit memo item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The service start date of the credit memo item.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"onAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n"
}
},
"description": "Container for the finance information related to the credit memo item.\n"
}
}
},
{
"$ref": "#/components/schemas/CreditMemoItemObjectCustomFields"
}
],
"title": "items"
}
CreditMemoItemFromWriteOffInvoice
{
"allOf": [
{
"type": "object",
"properties": {
"comment": {
"type": "string",
"description": "Comments about the credit memo item.\n"
},
"skuName": {
"type": "string",
"description": "The name of the charge associated with the invoice.\n"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the invoice item.\n"
},
"unitOfMeasure": {
"type": "string",
"description": "The definable unit that you measure when determining charges.\n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The service end date of the credit memo item. \n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The service start date of the credit memo item. \n"
},
"financeInformation": {
"type": "object",
"properties": {
"onAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n"
}
},
"description": "Container for the finance information related to the credit memo item.\n"
}
}
},
{
"$ref": "#/components/schemas/CreditMemoItemObjectCustomFields"
}
],
"title": "items"
}
CreditMemoItemObjectCustomFields
{
"type": "object",
"title": "creditMemoItemFieldsCustom",
"description": "Container for custom fields of a Credit Memo Item object.\n",
"additionalProperties": {
"description": "Custom fields of the Credit Memo Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
CreditMemoObjectCustomFields
{
"type": "object",
"title": "creditMemoFieldsCustom",
"description": "Container for custom fields of a Credit Memo object.\n",
"additionalProperties": {
"description": "Custom fields of the Credit Memo object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
CreditMemoObjectNSFields
{
"type": "object",
"title": "creditMemoFieldsNS",
"properties": {
"Origin__NS": {
"type": "string",
"maxLength": 255,
"description": "Origin of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"SyncDate__NS": {
"type": "string",
"maxLength": 255,
"description": "Date when the credit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"Transaction__NS": {
"type": "string",
"maxLength": 255,
"description": "Related transaction in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationId__NS": {
"type": "string",
"maxLength": 255,
"description": "ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationStatus__NS": {
"type": "string",
"maxLength": 255,
"description": "Status of the credit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
},
"description": "Container for Credit Memo fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
CreditMemoResponseType
{
"type": "object",
"title": "creditMemos",
"properties": {
"id": {
"type": "string",
"description": "The ID of the generated credit memo.\n"
}
}
}
CreditMemoTaxItemFromInvoiceTaxItemType
{
"type": "object",
"title": "taxItems",
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the credit memo taxation item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific credit memo. \n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date that the tax is applied to the credit memo, in `yyyy-mm-dd` format.\n"
},
"taxName": {
"type": "string",
"description": "The name of taxation.\n"
},
"taxRate": {
"type": "number",
"format": "double",
"description": "The tax rate applied to the credit memo.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate applied to the credit memo. \n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. \n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field.\n"
},
"sourceTaxItemId": {
"type": "string",
"description": "The ID of the source taxation item.\n"
},
"taxExemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"onAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"salesTaxPayableAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the sales taxes payable.\n"
}
},
"description": "Container for the finance information related to the source taxation item.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate. \n"
}
}
}
CreditMemoUnapplyDebitMemoItemRequestType
{
"type": "object",
"title": "items",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount that is unapplied from the specific item. \n"
},
"taxItemId": {
"type": "string",
"description": "The ID of the debit memo taxation item that the credit memo taxation item is unapplied from.\n"
},
"creditTaxItemId": {
"type": "string",
"description": "The ID of the credit memo taxation item.\n"
},
"debitMemoItemId": {
"type": "string",
"description": "The ID of the debit memo item that the credit memo item is unapplied from.\n"
},
"creditMemoItemId": {
"type": "string",
"description": "The ID of the credit memo item.\n"
}
}
}
CreditMemoUnapplyDebitMemoRequestType
{
"type": "object",
"title": "debitMemos",
"required": [
"amount",
"debitMemoId"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoUnapplyDebitMemoItemRequestType"
},
"description": "Container for items. The maximum number of items is 1,000.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The credit memo amount to be unapplied from the debit memo.\n"
},
"debitMemoId": {
"type": "string",
"description": "The unique ID of the debit memo that the credit memo is unapplied from.\n"
}
}
}
CreditMemoUnapplyInvoiceItemRequestType
{
"type": "object",
"title": "items",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount that is unapplied from the specific item. \n"
},
"taxItemId": {
"type": "string",
"description": "The ID of the invoice taxation item that the credit memo taxation item is unapplied from.\n"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the invoice item that the credit memo item is unapplied from.\n"
},
"creditTaxItemId": {
"type": "string",
"description": "The ID of the credit memo taxation item.\n"
},
"creditMemoItemId": {
"type": "string",
"description": "The ID of the credit memo item.\n"
}
}
}
CreditMemoUnapplyInvoiceRequestType
{
"type": "object",
"title": "invoices",
"required": [
"amount",
"invoiceId"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoUnapplyInvoiceItemRequestType"
},
"description": "Container for items. The maximum number of items is 1,000.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The credit memo amount to be unapplied from the invoice.\n"
},
"invoiceId": {
"type": "string",
"description": "The unique ID of the invoice that the credit memo is unapplied from.\n"
}
}
}
CreditTaxationItemObjectCustomFields
{
"type": "object",
"title": "creditTaxationItemFieldsCustom",
"description": "Container for custom fields of a Credit Taxation Item object.\n",
"additionalProperties": {
"description": "Custom fields of the Credit Taxation Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
CustomAccountPaymentMethod
{
"type": "object",
"title": "CustomPaymentMethod",
"description": "Container for 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\n**Note:** The response could return more than one custom payment methods.\n",
"additionalProperties": {
"type": "object",
"title": "Custom Payment Method",
"description": "Container for 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\n**Note:** The response could return more than one custom payment methods.\n"
}
}
CustomFields
{
"type": "object",
"title": "CustomFields",
"description": "Container for custom fields.\n",
"additionalProperties": {
"description": "The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information. \n\nThe Sign up API is based on Orders. The root element uses the custom field defintion on an \"Order\" object, `accountData` uses the custom field defintion on an \"Account\" object, and `subscriptionData` uses the custom field defintion on an \"Order Action\" object (not on an \"Subscription\" object).\n"
}
}
CustomObjectAllFieldsDefinition
{
"allOf": [
{
"type": "object",
"properties": {
"Id": {
"type": "object",
"properties": {
"type": {
"enum": [
"string"
],
"type": "string",
"description": "The field data type"
},
"label": {
"type": "string",
"description": "The UI name of the field"
},
"format": {
"enum": [
"uuid"
],
"type": "string",
"description": "The field data format"
},
"origin": {
"enum": [
"system"
],
"type": "string",
"description": "Specifies whether the field is a system field or a custom field"
}
},
"description": "The `Id` field definition"
},
"CreatedById": {
"type": "object",
"properties": {
"type": {
"enum": [
"string"
],
"type": "string",
"description": "The field data type"
},
"label": {
"type": "string",
"description": "The UI name of the field"
},
"format": {
"enum": [
"uuid"
],
"type": "string",
"description": "The field data format"
},
"origin": {
"enum": [
"system"
],
"type": "string",
"description": "Specifies whether the field is a system field or a custom field"
}
},
"description": "The `CreatedById` field definition"
},
"CreatedDate": {
"type": "object",
"properties": {
"type": {
"enum": [
"string"
],
"type": "string",
"description": "The field data type"
},
"format": {
"enum": [
"date-time"
],
"type": "string",
"description": "The field data format"
},
"origin": {
"enum": [
"system"
],
"type": "string",
"description": "Specifies the field is a system field"
}
},
"description": "The `CreatedDate` field definition"
},
"UpdatedById": {
"type": "object",
"properties": {
"type": {
"enum": [
"string"
],
"type": "string",
"description": "The field data type"
},
"label": {
"type": "string",
"description": "The UI name of the field"
},
"format": {
"enum": [
"uuid"
],
"type": "string",
"description": "The field data format"
},
"origin": {
"enum": [
"system"
],
"type": "string",
"description": "Specifies whether the field is a system field or a custom field"
}
},
"description": "The `UpdatedById` field definition"
},
"UpdatedDate": {
"type": "object",
"properties": {
"type": {
"enum": [
"string"
],
"type": "string",
"description": "The field data type"
},
"format": {
"enum": [
"date-time"
],
"type": "string",
"description": "The field data format"
},
"origin": {
"enum": [
"system"
],
"type": "string",
"description": "Specifies the field is a system field"
}
},
"description": "The `UpdatedDate` field definition"
}
}
},
{
"$ref": "#/components/schemas/CustomObjectCustomFieldsDefinition"
}
],
"title": "customObjectFieldDefinition",
"description": "The definitions of all the fields in the custom object definition"
}
CustomObjectBulkDeleteFilter
{
"type": "object",
"required": [
"conditions"
],
"properties": {
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomObjectBulkDeleteFilterCondition"
},
"description": "Group of field filter conditions that are evaluated in conjunction with each other using the AND operator. The minimum number of conditions is 1 and the maximum is 2."
}
},
"description": "Filters to determine which records to be deleted in the bulk delete operation."
}
CustomObjectBulkDeleteFilterCondition
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string",
"example": "CreatedDate",
"description": "The object field that is evaluated. Only filterable fields can be evaluated in the filter."
},
"value": {
"example": "2020-01-01T00:00:00.000Z",
"description": "The value that the filterable `field` is evaluated against in the filter. The data type of `value` is consistent with that of the `field`."
},
"operator": {
"enum": [
"EQ",
"GT",
"LT",
"GE",
"LE"
],
"type": "string",
"example": "LT"
}
},
"description": "Condition evaluated on a single object field"
}
CustomObjectBulkJobErrorResponse
{
"type": "object",
"properties": {
"row": {
"type": "integer",
"format": "Int32",
"example": 12,
"description": "The CSV record row number. The custom object record data starts at the second row because the first row is the CSV header."
},
"code": {
"type": "integer",
"format": "Int32",
"example": 71012520,
"description": "The error code."
},
"record": {
"$ref": "#/components/schemas/CustomObjectRecordWithAllFields"
},
"message": {
"type": "string",
"example": "input string \"123\" is not a valid UUID",
"description": "The error message."
}
}
}
CustomObjectBulkJobErrorResponseCollection
{
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomObjectBulkJobErrorResponse"
},
"description": "All errors for a custom object bulk job."
}
}
}
CustomObjectBulkJobRequest
{
"type": "object",
"required": [
"operation",
"object",
"namespace"
],
"properties": {
"filter": {
"$ref": "#/components/schemas/CustomObjectBulkDeleteFilter"
},
"object": {
"type": "string",
"example": "passenger",
"description": "The object that the bulk operation performs on."
},
"namespace": {
"enum": [
"default",
"com_zuora"
],
"type": "string",
"description": "The namespace of the object. Custom objects belong to the `default` namespace. Zuora standard objects belong to the `com_zuora` namespace. Bulk job operations on the following Zuora standard objects are supported:\n* SavedQuery\n"
},
"operation": {
"enum": [
"delete",
"create",
"update"
],
"type": "string",
"description": "The operation that the bulk job performs. Only the users that have the \"Delete Custom Objects\" permission can submit a `delete` bulk job request. Only the users that have the \"Edit Custom Objects\" permission can submit a `create` or `update` bulk job request. See [Platform Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/h_Platform_Roles#Platform_Permissions) for more information."
}
}
}
CustomObjectBulkJobResponse
{
"type": "object",
"example": {
"Id": "ed4b9701-bafb-4976-8019-b08269430153",
"error": {
"code": 71012560,
"message": "Service limit reached, please retry later."
},
"object": "passenger",
"status": "failed",
"namespace": "default",
"operation": "delete",
"CreatedById": "7b39d73f-22e6-404a-b8e7-894f7620e91c",
"CreatedDate": "2021-03-15T06:47:18Z",
"UpdatedById": "7b39d73f-22e6-404a-b8e7-894f7620e91c",
"UpdatedDate": "2021-03-15T06:47:18Z",
"processingTime": 1882,
"recordsProcessed": 500
},
"properties": {
"Id": {
"type": "string",
"format": "uuid",
"description": "The custom object bulk job ID."
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "Int32",
"example": 71012560,
"description": "The error code."
},
"message": {
"type": "string",
"example": "Service limit reached, please retry later.",
"description": "The error message."
}
}
},
"object": {
"type": "string",
"example": "passenger",
"description": "The object to that the bulk operation performs on."
},
"status": {
"enum": [
"accepted",
"pending",
"in_progress",
"completed",
"failed",
"cancelled"
],
"type": "string",
"example": "failed",
"description": "The status of the bulk job:\n\n- `accepted` - The job has been accepted and is ready to process.\n- `pending` - The job is waiting for your input. You can use [Upload a file for a custom object bulk job](https://developer.zuora.com/api-references/api/operation/POST_UploadFileForCustomObjectBulkJob) to upload a file so that the job can start creating records.\n- `in_progress` - The job is processing.\n- `completed` - The job has completed.\n- `failed` - The job was unable to complete. You can use [List all errors for a custom object bulk job](https://developer.zuora.com/api-references/api/operation/GET_CustomObjectBulkJobErrors) to list the errors.\n- `cancelled` - The job was cancelled by the server.\n"
},
"namespace": {
"enum": [
"default",
"com_zuora"
],
"type": "string",
"description": "The namespace of the object. Custom objects belong to the `default` namespace. Zuora standard objects belong to the `com_zuora` namespace. Bulk job operations on the following Zuora standard objects are supported:\n* SavedQuery\n"
},
"operation": {
"enum": [
"delete",
"create",
"update"
],
"type": "string",
"description": "The operation that the bulk job performs. Only the users that have the \"Delete Custom Objects\" permission can submit a `delete` bulk job request. Only the users that have the \"Edit Custom Objects\" permission can submit a `create` or `update` bulk job request. See [Platform Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/h_Platform_Roles#Platform_Permissions) for more information.\n"
},
"CreatedById": {
"type": "string",
"format": "uuid",
"description": "The ID of the user who creates the job."
},
"CreatedDate": {
"type": "string",
"format": "date-time",
"description": "The time when the bulk job is created."
},
"UpdatedById": {
"type": "string",
"format": "uuid",
"description": "The ID of the user who updates the job."
},
"UpdatedDate": {
"type": "string",
"format": "date-time",
"description": "The time when the bulk job is updated."
},
"processingTime": {
"type": "integer",
"example": 550,
"description": "The amount of time elapsed, in milliseconds, from the submission to the completion of the bulk job."
},
"recordsProcessed": {
"type": "integer",
"example": 1000,
"description": "The number of object records processed by the bulk job."
}
}
}
CustomObjectBulkJobResponseCollection
{
"type": "object",
"required": [
"jobs"
],
"properties": {
"jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomObjectBulkJobResponse"
},
"example": [
{
"Id": "5112347a-f7a1-4373-99df-c082984de7be",
"object": "vehicle",
"status": "completed",
"namespace": "default",
"operation": "create",
"CreatedById": "2c92c0f96a07409d016a0a58ab1172ec",
"CreatedDate": "2021-03-10T00:05:54.207Z",
"UpdatedById": "2c92c0f96a07409d016a0a58ab1172ec",
"UpdatedDate": "2021-03-10T00:08:15.614Z",
"processingTime": 62,
"recordsProcessed": 3
},
{
"Id": "a9e9a58d-0a11-4685-b1ab-99521dbc20a1",
"object": "vehicle",
"status": "pending",
"namespace": "default",
"operation": "create",
"CreatedById": "2c92c0f96a07409d016a0a58ab1172ec",
"CreatedDate": "2021-03-09T22:27:59.503Z",
"UpdatedById": "2c92c0f96a07409d016a0a58ab1172ec",
"UpdatedDate": "2021-03-09T22:27:59.503Z",
"processingTime": 0,
"recordsProcessed": 0
}
],
"description": "All custom object bulk jobs returned in the result page set."
},
"count": {
"type": "integer",
"example": 2,
"description": "The number of custom object bulk jobs returned in the result page set."
},
"cursor": {
"type": "string",
"example": "a9e9a58d-0a11-4685-b1ab-99521dbc20a1",
"description": "The `cursor` points to the last job record of the current page."
}
}
}
CustomObjectCustomFieldDefinition
{
"type": "object",
"title": "customObjectCustomFieldDefinition",
"properties": {
"type": {
"type": "string",
"description": "The data type of the custom field"
},
"label": {
"type": "string",
"description": "The UI label of the custom field"
},
"format": {
"type": "string",
"description": "The data format of the custom field"
},
"origin": {
"enum": [
"custom"
],
"type": "string",
"description": "Specifies that this is a custom field"
},
"maxLength": {
"type": "integer",
"description": "The maximum length of string that can be stored in the custom field.\n\nThis field applies only to the following custom field types:\n\n- Text:\n - The `type` field is `string`.\n - The `format` field is not specified or is `url`.\n - The `enum` field is not specified.\n- Picklist:\n - The `type` field is `string`.\n - The `enum` field is specified.\n - The `multiselect` field is not specified or is `false`.\n- Multiselect:\n - The `type` field is `string`.\n - The `enum` field is specified.\n - The `multiselect` field is `true`.\n"
},
"displayName": {
"type": "boolean",
"description": "Indicates whether to use this field as the display name of the custom object when being linked to another custom object.\n\nThis field applies only to the Text custom field type:\n\n- The `type` field is `string`.\n- The `enum` field is not specified.\n"
},
"multiselect": {
"type": "boolean",
"description": "Indicates whether this is a multiselect custom field.\n\nThis field applies only to the Picklist or Multiselect custom field types:\n\n- The `type` field is `string`.\n- The `maxLength` field is specified.\n- The `enum` field is specified.\n"
}
},
"description": "The custom field definition in the custom object"
}
CustomObjectCustomFieldDefinitionUpdate
{
"type": "object",
"title": "customObjectCustomFieldDefinition",
"properties": {
"type": {
"type": "string",
"description": "The data type of the custom field"
},
"label": {
"type": "string",
"description": "The UI label of the custom field"
},
"format": {
"type": "string",
"description": "The data format of the custom field"
},
"origin": {
"enum": [
"custom"
],
"type": "string",
"description": "Specifies that this is a custom field"
},
"default": {
"type": "string",
"description": "Applicable if the `type` of the action is `updateField`"
},
"maxLength": {
"type": "integer",
"description": "The maximum length of string that can be stored in the custom field.\n\nThis field applies only to the following custom field types:\n\n- Text:\n - The `type` field is `string`.\n - The `format` field is not specified or is `url`.\n - The `enum` field is not specified.\n- Picklist:\n - The `type` field is `string`.\n - The `enum` field is specified.\n - The `multiselect` field is not specified or is `false`.\n- Multiselect:\n - The `type` field is `string`.\n - The `enum` field is specified.\n - The `multiselect` field is `true`.\n\nIf the custom field is filterable, the value of `maxLength` must be 512 or less.\n"
},
"description": {
"type": "string",
"description": "Applicable if the `type` of the action is `updateField`"
},
"displayName": {
"type": "boolean",
"description": "Indicates whether to use this field as the display name of the custom object when being linked to another custom object.\n\nThis field applies only to the Text custom field type:\n\n- The `type` field is `string`.\n- The `enum` field is not specified.\n"
},
"multiselect": {
"type": "boolean",
"description": "Indicates whether this is a multiselect custom field.\n\nThis field applies only to the creation of Picklist or Multiselect custom fields:\n\n- The action `type` field is `addField`.\n- The definition `type` field is `string`.\n- The `maxLength` field is specified.\n- The `enum` field is specified.\n"
}
},
"description": "The custom field definition in the custom object"
}
CustomObjectCustomFieldsDefinition
{
"type": "object",
"title": "customObjectCustomFieldDefinition",
"description": "The custom field definition in the custom object definition",
"additionalProperties": {
"$ref": "#/components/schemas/CustomObjectCustomFieldDefinition"
}
}
CustomObjectDefinition
{
"type": "object",
"title": "customObjectDefinition",
"example": {
"Id": "df7f10f9-4ec9-4389-a9eb-a6a3d549bb61",
"type": "person",
"schema": {
"type": "object",
"label": "Personal Profile",
"object": "person",
"required": [
"last_name__c",
"marital_status__c"
],
"filterable": [
"last_name__c",
"email__c"
],
"properties": {
"Id": {
"type": "string",
"label": "Id",
"format": "uuid",
"origin": "system"
},
"age__c": {
"type": "integer",
"origin": "custom",
"minimum": 0,
"description": "Age in years"
},
"email__c": {
"type": "string",
"format": "email",
"origin": "custom",
"maxLength": 128
},
"CreatedById": {
"type": "string",
"label": "CreatedById",
"format": "uuid",
"origin": "system"
},
"CreatedDate": {
"type": "string",
"label": "CreatedDate",
"format": "date-time",
"origin": "system"
},
"UpdatedById": {
"type": "string",
"label": "UpdatedById",
"format": "uuid",
"origin": "system"
},
"UpdatedDate": {
"type": "string",
"label": "UpdatedDate",
"format": "date-time",
"origin": "system"
},
"last_name__c": {
"type": "string",
"origin": "custom",
"maxLength": 128
},
"home_address__c": {
"type": "string",
"format": "uuid",
"origin": "custom"
},
"work_address__c": {
"type": "string",
"format": "uuid",
"origin": "custom"
},
"marital_status__c": {
"enum": [
"Single",
"Married",
"Unknown"
],
"type": "string",
"origin": "custom",
"default": "Unknown"
}
},
"relationships": [
{
"fields": {
"home_address__c": "Id"
},
"object": "address",
"namespace": "default",
"cardinality": "manyToOne",
"recordConstraints": {
"create": {
"enforceValidMapping": false
}
}
},
{
"fields": {
"work_address__c": "Id"
},
"object": "address",
"namespace": "default",
"cardinality": "manyToOne",
"recordConstraints": {
"create": {
"enforceValidMapping": false
}
}
},
{
"fields": {
"Id": "person_id__c"
},
"object": "car",
"namespace": "default",
"cardinality": "oneToMany",
"recordConstraints": {
"create": {
"enforceValidMapping": false
}
}
},
{
"fields": {
"Id": "person_id__c"
},
"object": "device",
"namespace": "default",
"cardinality": "oneToMany",
"recordConstraints": {
"create": {
"enforceValidMapping": false
}
}
}
]
},
"CreatedById": "7b39d73f-22e6-404a-b8e7-894f7620e91c",
"CreatedDate": "2019-09-29T06:45:23.378Z",
"UpdatedById": "7b39d73f-22e6-404a-b8e7-894f7620e91c",
"UpdatedDate": "2019-09-29T06:45:23.378Z"
},
"properties": {
"Id": {
"type": "string",
"format": "uuid",
"description": "The unique Id of the custom object definition"
},
"type": {
"type": "string",
"description": "The API name of the custom object"
},
"schema": {
"type": "object",
"properties": {
"type": {
"enum": [
"object"
],
"type": "string",
"description": "The custom object definition type. Can only be `object` currently."
},
"label": {
"type": "string",
"description": "A label for the custom object"
},
"object": {
"type": "string",
"description": "The API name of the custom object"
},
"unique": {
"type": "array",
"items": {
"type": "string"
},
"description": "The fields with unique constraints."
},
"required": {
"type": "array",
"items": {
"type": "string"
},
"description": "The required fields of the custom object definition. You can change required fields to optional. However, you can only change optional fields to required on the custom objects with no records."
},
"auditable": {
"type": "array",
"items": {
"type": "string"
},
"description": "The set of fields which Audit Trail tracks and records changes of."
},
"filterable": {
"type": "array",
"items": {
"type": "string"
},
"description": "The set of fields that are allowed to be queried on. Queries on non-filterable fields will be rejected. You can not change a non-filterable field to filterable."
},
"properties": {
"$ref": "#/components/schemas/CustomObjectAllFieldsDefinition"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fields": {
"$ref": "#/components/schemas/FieldsAdditionalProperties"
},
"object": {
"type": "string",
"description": "The API name of the related object"
},
"namespace": {
"type": "string",
"description": "The namespace where the related object is located"
},
"cardinality": {
"enum": [
"manyToOne",
"oneToMany"
],
"type": "string",
"default": "manyToOne",
"description": "The cardinality of the relationship from this object to another object.\n\nA `manyToOne` relationship means this object is the child object (the \"many\" side), and the referenced object (the \"one\" side) is the parent.\n\nA `oneToMany` relationship means this object is the parent object (the \"one\" side), and the referenced object (the \"many\" side) is the child.\n"
},
"recordConstraints": {
"type": "object",
"properties": {
"create": {
"type": "object",
"properties": {
"enforceValidMapping": {
"type": "boolean",
"description": "Specifies whether Zuora validates the values of mapped fields\nin custom object records.\n"
}
}
}
},
"description": "Specifies contraints to apply to custom object records.\n"
}
}
},
"description": "An array of relationships with Zuora objects or other custom objects"
},
"enableCreateRecordAuditing": {
"type": "boolean",
"description": "Indicates whether to audit the creation of custom object records of this custom object definition."
},
"enableDeleteRecordAuditing": {
"type": "boolean",
"description": "Indicates whether to audit the deletion of custom object records of this custom object definition."
}
},
"description": "The schema of the custom object definition"
},
"CreatedById": {
"type": "string",
"format": "uuid",
"description": "The creator's Id"
},
"CreatedDate": {
"type": "string",
"format": "date-time",
"description": "The creation time of the custom object definition in date-time format."
},
"UpdatedById": {
"type": "string",
"format": "uuid",
"description": "The modifier's Id"
},
"UpdatedDate": {
"type": "string",
"format": "date-time",
"description": "The update time of the custom object definition in date-time format."
}
}
}
CustomObjectDefinitionUpdateActionRequest
{
"type": "object",
"example": {
"type": "addField",
"field": {
"name": "zip__c",
"definition": {
"type": "string",
"label": "Zip code",
"maxLength": 10,
"description": "Address zip code"
}
},
"object": "address",
"namespace": "default"
},
"required": [
"type",
"namespace",
"object"
],
"properties": {
"type": {
"enum": [
"addField",
"deleteField",
"updateField",
"updateObject",
"renameField",
"addRelationship",
"deleteRelationship"
],
"type": "string",
"description": "The type of the updating action on a custom object definition"
},
"field": {
"$ref": "#/components/schemas/UpdateCustomObjectCusotmField"
},
"label": {
"type": "string",
"description": "Optional property for `updateObject` action"
},
"object": {
"type": "string",
"description": "The API name of the custom object definition to be updated"
},
"namespace": {
"type": "string",
"description": "The namespace of the custom object definition to be updated"
},
"description": {
"type": "string",
"description": "Optional property for `updateObject` action"
},
"relationship": {
"type": "object",
"required": [
"namespace",
"object",
"fields"
],
"properties": {
"fields": {
"$ref": "#/components/schemas/FieldsAdditionalProperties"
},
"object": {
"type": "string",
"description": "The API name of the related object"
},
"namespace": {
"type": "string",
"description": "The namespace where the related object is located"
},
"cardinality": {
"enum": [
"manyToOne"
],
"type": "string",
"description": "The cardinality of the relationship from this object to another object.\n\nOnly the `manyToOne` cardinality can be used when creating relationships. A relationship with `oneToMany` cardinality is created implicitly when a `manyToOne` relationship is created.\n\nA custom object definition can have a maximum of 2 `manyToOne` relationships.\n"
},
"recordConstraints": {
"type": "object",
"properties": {
"create": {
"type": "object",
"properties": {
"enforceValidMapping": {
"type": "boolean",
"default": true,
"description": "Specifies whether Zuora validates the values of mapped fields\nin custom object records.\n\nBy default, Zuora validates the values of mapped fields\nin custom object records. For example, if the\ncustom object definition has a field called `AccountId__c`\nthat is mapped to the `Id` field of the `account` object,\nZuora verifies that the value of `AccountId__c` is a valid\naccount ID when a custom object record is created.\nIf the value of `AccountId__c` is not a valid account ID,\nthe operation fails.\n"
}
}
}
},
"description": "Specifies contraints to apply to custom object records.\n"
}
}
},
"enableCreateRecordAuditing": {
"type": "boolean",
"description": "Optional property for `updateObject` action.\n\nIndicates whether to audit the creation of custom object records of this custom object definition.\n\nNote that you must enable the **Custom Object Definition** audit trail setting in your Zuora tenant before auditing custom object record creation. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/Manage_Audit_Trail_Settings\" target=\"_blank\">Manage audit trail settings</a>.\n"
},
"enableDeleteRecordAuditing": {
"type": "boolean",
"description": "Optional property for `updateObject` action.\n\nIndicates whether to audit the deletion of custom object records of this custom object definition.\n\nNote that you must enable the **Custom Object Definition** audit trail setting in your Zuora tenant before auditing custom object record deletion. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/Manage_Audit_Trail_Settings\" target=\"_blank\">Manage audit trail settings</a>.\n"
}
}
}
CustomObjectDefinitionUpdateActionResponse
{
"type": "object",
"example": {
"type": "addField",
"field": {
"name": "zip__c",
"definition": {
"type": "string",
"label": "Zip code",
"maxLength": 10,
"description": "Address zip code"
}
},
"object": "address",
"namespace": "default"
},
"properties": {
"type": {
"enum": [
"addField",
"deleteField",
"updateField",
"updateObject",
"renameField",
"addRelationship",
"deleteRelationship"
],
"type": "string",
"description": "The type of the updating action on a custom object definition"
},
"field": {
"$ref": "#/components/schemas/UpdateCustomObjectCusotmField"
},
"label": {
"type": "string",
"description": "Optional property for `updateObject` action"
},
"object": {
"type": "string",
"description": "The API name of the custom object definition to be updated"
},
"namespace": {
"type": "string",
"description": "The namespace of the custom object definition to be updated"
},
"description": {
"type": "string",
"description": "Optional property for `updateObject` action"
},
"relationship": {
"type": "object",
"properties": {
"fields": {
"$ref": "#/components/schemas/FieldsAdditionalProperties"
},
"object": {
"type": "string",
"description": "The API name of the related object"
},
"namespace": {
"type": "string",
"description": "The namespace where the related object is located"
},
"cardinality": {
"enum": [
"manyToOne",
"oneToMany"
],
"type": "string",
"default": "manyToOne",
"description": "The cardinality of the relationship from this object to another object.\n\nA `manyToOne` relationship means this object is the child object (the \"many\" side), and the referenced object (the \"one\" side) is the parent.\n\nA `oneToMany` relationship means this object is the parent object (the \"one\" side), and the referenced object (the \"many\" side) is the child.\n"
},
"recordConstraints": {
"type": "object",
"properties": {
"create": {
"type": "object",
"properties": {
"enforceValidMapping": {
"type": "boolean",
"default": true,
"description": "Specifies whether Zuora validates the values of mapped fields\nin custom object records.\n"
}
}
}
},
"description": "Specifies contraints to apply to custom object records.\n"
}
}
},
"enableCreateRecordAuditing": {
"type": "boolean",
"description": "Indicates whether to audit the creation of custom object records of this custom object definition."
},
"enableDeleteRecordAuditing": {
"type": "boolean",
"description": "Indicates whether to audit the deletion of custom object records of this custom object definition."
}
}
}
CustomObjectDefinitions
{
"type": "object",
"title": "customObjectDefinitions",
"description": "The custom object definitions. This object maps types to custom object definitions.",
"additionalProperties": {
"$ref": "#/components/schemas/CustomObjectDefinition"
}
}
CustomObjectRecordBatchAction
{
"type": "object",
"title": "updateDeleteBatchAction",
"required": [
"type"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"example": [
"64edb2a5-2796-4e95-9559-846f8636a01b",
"dbfb35a3-dd2b-42c9-b8f7-eb36fed1a1e1",
"2c2a1810-bfef-4150-84de-50e769978e42"
],
"description": "Ids of the custom object records that you want to delete. Each ID must be a string of 36 characters. Only applicable when `type` is `delete`."
},
"type": {
"enum": [
"delete",
"update"
],
"type": "string",
"description": "The type of the batch action"
},
"records": {
"$ref": "#/components/schemas/CustomObjectRecordBatchUpdateMapping"
},
"allowPartialSuccess": {
"type": "boolean",
"default": false,
"example": true,
"description": "Indicates whether the records that pass the schema validation should be updated when not all records in the request pass the schema validation.\n\nOnly applicable when `type` is `update`.\n"
}
},
"description": "The batch action on custom object records"
}
CustomObjectRecordBatchRequest
{
"type": "object",
"example": {
"action": {
"type": "update",
"records": {
"64edb2a5-2796-4e95-9559-846f8636a01b": {
"age__c": "eighteen",
"name__c": "elba43",
"person_id__c": "30c52793-8f06-41c6-b623-04829710d7a"
}
},
"allowPartialSuccess": true
}
},
"required": [
"action"
],
"properties": {
"action": {
"$ref": "#/components/schemas/CustomObjectRecordBatchAction"
}
},
"description": "Request of processing custom object records in batch."
}
CustomObjectRecordBatchUpdateMapping
{
"type": "object",
"title": "updateIdFieldsMapping",
"example": {
"64edb2a5-2796-4e95-9559-846f8636a01b": {
"name__c": "elba43",
"person_id__c\"": "30c52793-8f06-41c6-b623-04829710d7a"
}
},
"description": "Object records that you want to update. Only applicable when `type` is `update`.",
"additionalProperties": {
"type": "object",
"description": "Map of object Id and associated custom fields data to be updated"
}
}
CustomObjectRecordWithAllFields
{
"type": "object",
"allOf": [
{
"properties": {
"Id": {
"type": "string",
"format": "uuid",
"maxLength": 36,
"minLength": 36,
"description": "The unique Id of the custom object record"
},
"type": {
"type": "string",
"description": "The type of the custom object record. It is the API name of the custom object definition."
},
"CreatedById": {
"type": "string",
"description": "The creator's Id"
},
"CreatedDate": {
"type": "string",
"format": "date-time",
"description": "The record creation time in the date-time format"
},
"UpdatedById": {
"type": "string",
"description": "The modifier's Id"
},
"UpdatedDate": {
"type": "string",
"format": "date-time",
"description": "The record modification time in the date-time format"
}
}
},
{
"$ref": "#/components/schemas/CustomObjectRecordWithOnlyCustomFields"
}
],
"title": "customObjectRecord",
"example": {
"Id": "f4f3d0a8-9d45-43d6-956c-4820f2de7559",
"type": "person",
"age__c": 32,
"version": 1,
"email__c": "smith123@example.com",
"CreatedById": "58bcc694-0b01-4c38-83d9-679891aee4dc",
"CreatedDate": "2017-06-07T17:26:47.501Z",
"UpdatedById": "58bcc694-0b01-4c38-83d9-679891aee4dc",
"UpdatedDate": "2017-06-07T17:26:47.501Z",
"last_name__c": "Smith",
"home_address__c": "59b38ad1-27d4-40e8-af66-8c138bc382ee",
"work_address__c": "8a19f16a-2b5e-4a26-bb20-c79cd6984714",
"marital_status__c": "Married"
},
"description": "Record data from an object"
}
CustomObjectRecordWithOnlyCustomFields
{
"type": "object",
"title": "customObjectRecord",
"example": {
"age__c": 32,
"email__c": "smith123@example.com",
"last_name__c": "Smith",
"home_address__c": "59b38ad1-27d4-40e8-af66-8c138bc382ee",
"work_address__c": "8a19f16a-2b5e-4a26-bb20-c79cd6984714",
"marital_status__c": "Married"
},
"additionalProperties": {
"description": "The field-value pairs for a custom object record"
}
}
CustomObjectRecordsBatchUpdatePartialSuccessResponse
{
"type": "object",
"example": {
"error": {
"code": "710125XX",
"details": [
{
"code": "710125XX",
"record": {
"Id": "64edb2a5-2796-4e95-9559-846f8636a01b",
"age__c": 19,
"name__c": "elba43",
"person_id__c": "30c52793-8f06-41c6-b623-04829710d7a"
},
"message": "Field [age__c] is an integer field but received a string value."
}
],
"message": "Unabled to update object records due to invalid request."
}
},
"properties": {
"error": {
"$ref": "#/components/schemas/CustomObjectRecordsErrorResponse"
}
}
}
CustomObjectRecordsErrorResponse
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "Int32",
"example": 710125
},
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomObjectRecordsWithError"
},
"example": [
{
"code": "710125XX",
"record": {
"Id": "8a19f16a-2b5e-4a26-bb20-c79cd6984714",
"age__c": "32",
"email__c": "smith123@example.com",
"last_name__c": "Smith",
"home_address__c": "59b38ad1-27d4-40e8-af66-8c138bc382ee",
"work_address__c": "8a19f16a-2b5e-4a26-bb20-c79cd6984714",
"marital_status__c": "Married"
},
"message": "Field [age__c] is an integer field but received a string value."
}
]
},
"message": {
"type": "string",
"example": "Unabled to create object records due to invalid request."
}
}
}
CustomObjectRecordsThrottledResponse
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "Int32",
"example": 71012561
},
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomObjectRecordsWithError"
},
"example": [
{
"code": 71012561,
"record": {
"Id": "8a19f16a-2b5e-4a26-bb20-c79cd6984714",
"age__c": 32,
"email__c": "smith123@example.com",
"last_name__c": "Smith",
"home_address__c": "59b38ad1-27d4-40e8-af66-8c138bc382ee",
"work_address__c": "8a19f16a-2b5e-4a26-bb20-c79cd6984714",
"marital_status__c": "Married"
},
"message": "Unable to process record due to internal error or database throttling."
}
]
},
"message": {
"type": "string",
"example": "Unabled to create object records, please try again later."
}
}
}
CustomObjectRecordsWithError
{
"type": "object",
"properties": {
"code": {
"enum": [
71012520,
71012521,
71012522,
71012523,
71012524,
71012525,
71012526,
71012530
],
"type": "integer",
"format": "Int32",
"description": "See [Custom Objects API error code](https://knowledgecenter.zuora.com/Central_Platform/Custom_Objects/Z_Custom_Objects_API#Custom_Objects_API_error_code) for details.\n"
},
"record": {
"$ref": "#/components/schemas/CustomObjectRecordWithAllFields"
},
"message": {
"type": "string",
"example": "Field [last_name__c] cannot accept empty string."
}
}
}
DELETEUnresigerApplePayDomainResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Indicates whether this call succeeds."
}
}
}
DailyConsumptionRevRecRequest
{
"type": "object",
"example": {
"fundId": "2c9890508ad035db018ad0d8d1685fef",
"originalChargeId": "2c9890508ad035db018ad0d8d1685fef",
"chargeSegmentNumber": "1"
},
"required": [
"originalChargeId"
],
"properties": {
"fundId": {
"type": "string",
"description": "Fund ID. For more information about fund, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown\" target=\"_blank\">Prepaid with Drawdown</a>.\n"
},
"originalChargeId": {
"type": "string",
"description": "Original rate plan charge ID.\n"
},
"chargeSegmentNumber": {
"type": "string",
"description": "Rate plan charge number.\n"
}
}
}
DataAccessControlField
{
"type": "object",
"title": "dataAccessControlField",
"description": "Container for the data access control field.\n",
"additionalProperties": {
"type": "string",
"description": "Field for data access control. The name of the data access control field has the form <code>*customField*__h</code>. The data access control field is case sensitive. See [Data Access Control](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/Data_Access_Control) for more information.\n"
}
}
DataBackfillJob
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Job ID"
},
"status": {
"$ref": "#/components/schemas/DataBackfillJobStatus"
},
"importType": {
"$ref": "#/components/schemas/DataBackfillJobType"
},
"outputSize": {
"type": "string",
"description": "Size of the output file. \n"
},
"outputType": {
"type": "string",
"description": "Type of the output file."
},
"totalCount": {
"type": "integer",
"format": "int32",
"description": "The total count of the data records to backfill\n"
},
"uploadedBy": {
"type": "string",
"description": "The user who uploads the file\n"
},
"uploadedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the file is uploaded\n"
},
"completedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the data backfill action is completed\n"
},
"failedCount": {
"type": "integer",
"format": "int32",
"description": "The count of the data records that failed to be backfilled\n"
},
"resultFileId": {
"type": "string",
"description": "ID of the output result file that you can download when a data backfill job is completed. \n"
},
"successCount": {
"type": "integer",
"format": "int64",
"description": "The count of the data records that are successfully backfilled\n"
},
"inputFileSize": {
"type": "integer",
"format": "int64",
"description": "Size of the uploaded file, in the `int64` format"
},
"remainingTime": {
"type": "integer",
"format": "int64",
"description": "The remaining time for the data backfill job, in the `int64` format\n"
},
"resultFileUrl": {
"type": "string",
"description": "URL of the result file that you can download when a data backfill job is completed. You can download the result file via this URL. In the result file, you can see the data that you uploaded and the result for each record in the `Success` column of the file. For the record that fails to be updated, you can see the reason for failure in the `Error Message` column of the file.\n"
},
"failureMessage": {
"type": "string",
"description": "Message for the failure\n"
},
"outputFileSize": {
"type": "integer",
"format": "int64",
"description": "Size of the output file, in the `int64` format. \n"
},
"processedCount": {
"type": "integer",
"format": "int64",
"description": "The count of the data records that are being processed\n"
},
"resultFileName": {
"type": "string",
"description": "Name of the result file that you can download when a data backfill job is completed\n"
},
"uploadedFileId": {
"type": "string",
"description": "ID of the uploaded file"
},
"uploadedFileUrl": {
"type": "string",
"description": "URL of the uploaded file. You can download the uploaded file via this url."
},
"uploadedFileName": {
"type": "string",
"description": "Name of the uploaded file"
},
"uploadedFileSize": {
"type": "string",
"description": "Size of the uploaded file"
},
"remainingTimeText": {
"type": "string",
"description": "The remaining time for the data backfill job, in the text format\n"
},
"completedPercentage": {
"type": "integer",
"format": "int32",
"description": "The percentage of the completed data records\n"
},
"startedProcessingOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the data backfill action is started\n"
}
}
}
DataBackfillJobStatus
{
"enum": [
"Pending",
"Processing",
"Completed",
"Canceled",
"Failed",
"Stopping",
"Stopped"
],
"type": "string",
"description": "The status of the data backfill job"
}
DataBackfillJobType
{
"enum": [
"ProductRatePlanCharge",
"RatePlanCharge",
"InvoiceDetail",
"MemoDetail",
"InvoiceItemAdjustment"
],
"type": "string",
"description": "The data backfill job type"
}
DataQueryErrorResponse
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "Error code.\n"
},
"message": {
"type": "string",
"description": "Error message.\n"
}
}
}
DataQueryJob
{
"allOf": [
{
"$ref": "#/components/schemas/DataQueryJobCommon"
},
{
"type": "object",
"properties": {
"dataFile": {
"type": "string",
"format": "URL",
"description": "The URL of the query results. Only applicable if the value of the `queryStatus` field is `completed`.\n"
},
"outputRows": {
"type": "integer",
"description": "The number of rows the query results. Only applicable if the value of the `queryStatus` field is `completed`.\n"
},
"queryStatus": {
"enum": [
"submitted",
"accepted",
"in_progress",
"completed",
"failed",
"cancelled"
],
"type": "string",
"description": "Status of the query job.\n\n* `submitted` - query submitted to query service for processing\n* `accepted` - query accepted by the query service\n* `in_progress` - query executed by the query service\n* `completed` - query execution completed by the query service\n* `failed` - query unable to be processed by the query service\n* `cancelled` - query cancelled by the user\n\nIf the value of this field is `completed`, the `dataFile` field contains the location of the query results.\n\nIf the value of this field is `accepted` or `in_progress`, you can use [Cancel a data query job](https://developer.zuora.com) to prevent Zuora from performing the query. Zuora then sets the status of the query job to `cancelled`.\n"
},
"processingTime": {
"type": "integer",
"description": "Processing time of the query job, in milliseconds. Only applicable if the value of the `queryStatus` field is `completed`.\n"
}
}
}
],
"title": "queryJob",
"description": "A data query job.\n"
}
DataQueryJobCancelled
{
"allOf": [
{
"$ref": "#/components/schemas/DataQueryJobCommon"
},
{
"type": "object",
"properties": {
"queryStatus": {
"enum": [
"cancelled"
],
"type": "string",
"description": "Status of the query job.\n"
}
}
}
],
"title": "cancelledQueryJob",
"description": "A cancelled data query job.\n"
}
DataQueryJobCommon
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"maxLength": 64,
"minLength": 64,
"description": "Internal identifier of the query job.\n"
},
"query": {
"type": "string",
"description": "The query that was submitted.\n"
},
"createdBy": {
"type": "string",
"format": "uuid",
"maxLength": 64,
"minLength": 64,
"description": "The query job creator's Id.\n"
},
"updatedOn": {
"type": "string",
"format": "date-time",
"description": "Date and time when the query job was last updated, in ISO 8601 format.\n"
},
"sourceData": {
"type": "string",
"description": "Indicates the source that data queries run against:\n\n* `LIVE` represents the live transactional databases at Zuora (Data Query Live).\n\n* `WAREHOUSE` represents Zuora Warehouse, which has better performance and fewer limitations than the live transactional database. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_Warehouse/A_Zuora_Warehouse_overview\" target=\"_blank\">Zuora Warehouse</a>.\n"
},
"useIndexJoin": {
"type": "boolean",
"description": "Indicates whether to use Index Join. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Query/Data_Query/Best_practices_when_writing_data_queries/General_best_practices#Index_JOIN\" target=\"_blank\">Index Join</a> for more information.\n"
},
"remainingRetries": {
"type": "integer",
"description": "The number of times that Zuora will retry the query if Zuora is unable to perform the query.\n"
}
}
}
DebitMemoCollectRequest
{
"type": "object",
"example": {
"collect": true,
"payment": {
"gatewayId": "2c98902f6f1de6d1016f1ded559f3b9d",
"paymentMethodId": "2c98902f6f1de6d1016f1dedba313ba2"
},
"applyCredit": true,
"applicationOrder": [
"CreditMemo",
"UnappliedPayment"
]
},
"properties": {
"collect": {
"type": "boolean",
"default": false,
"description": "Indicates if the current request needs to collect payment or not.\n"
},
"payment": {
"type": "object",
"properties": {
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the payment. The ID must be a valid gateway instance ID and this gateway must support the specific payment method.\nIf no gateway ID is specified in the request body, the default gateway for the customer account is used automatically, if this default one is not configured, the default gateway of the tenant would be used.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the payment.\nIf no payment method ID is specified in the request body, the default payment method for the customer account is used automatically. If the default payment method is different from the type of payments that you want to create, an error occurs.\n"
}
},
"description": "Some detail info that would be used to processed an electronic payment.\nThe info would only effect when `collect` set to `true`.\n"
},
"applyCredit": {
"type": "boolean",
"default": false,
"description": "Whether to automatically apply credit memos or unapplied payments, or both to the debit memo.\nIf the value is `true`, the credit memo or unapplied payment, or both will be automatically applied to the debit memo. If no value is specified or the value is `false`, no action is taken.\n"
},
"applicationOrder": {
"type": "array",
"items": {
"type": "string"
},
"description": "The priority order to apply credit memos and/or unapplied payments to the debit memo. Possible item values are: `CreditMemo`, `UnappliedPayment`.\n\n**Note:**\n - This field is valid only if the `applyCredit` field is set to `true`.\n - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.\n - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply the debit memo.\n"
}
}
}
DebitMemoCollectResponse
{
"allOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"debitMemo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the debit memo.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the debit memo.\n"
}
},
"description": "The information about the debit memo that just collected.\n"
},
"appliedPayments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DebitMemoCollectResponseAppliedPayments"
},
"description": "The information about which payment applied to the specific debit memo.\n"
},
"processedPayment": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the payment. For example, P-00000001.\n"
},
"status": {
"enum": [
"Processing",
"Processed",
"Error",
"Canceled"
],
"type": "string",
"description": "The status of the payment.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the payment.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the payment. This message is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the payment.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the payment. This code is gateway-dependent.\n"
}
},
"description": "The information about the payment that newly processed to the debit memo.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"appliedCreditMemos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DebitMemoCollectResponseAppliedCreditMemos"
},
"description": "The information about which credit memo applied to the specific debit memo.\n"
}
}
}
]
}
DebitMemoCollectResponseAppliedCreditMemos
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the credit memo.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the credit memo.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the credit memo to the debit memo.\n"
},
"unappliedAmount": {
"type": "number",
"format": "double",
"description": "The unapplied amount of the credit memo after applied to the debit memo.\n"
}
}
}
]
}
DebitMemoCollectResponseAppliedPayments
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the payment.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the payment.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the payment to the debit memo.\n"
},
"unappliedAmount": {
"type": "number",
"format": "double",
"description": "The unapplied amount of the payment after applied to the debit memo.\n"
}
}
}
]
}
DebitMemoEntityPrefix
{
"type": "object",
"title": "debitMemo",
"properties": {
"prefix": {
"type": "string",
"example": "DM",
"description": "The prefix of debit memos.\n"
},
"startNumber": {
"type": "integer",
"example": 10,
"description": "The starting document number of debit memos.\n"
}
},
"description": "Container for the prefix and starting document number of debit memos.\n\n**Note:** This field is only available if you have the Invoice Settlement feature 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
}
DebitMemoFile
{
"type": "object",
"title": "debitMemoFile",
"properties": {
"id": {
"type": "string",
"description": "The ID of the debit memo PDF file. This is the ID for the file object and different from the file handle ID in the `pdfFileUrl` field. To open a file, you have to use the file handle ID.\n"
},
"pdfFileUrl": {
"type": "string",
"description": "The REST URL for the debit memo PDF file. Click the URL to open the debit memo PDF file.\n"
},
"versionNumber": {
"type": "integer",
"format": "int64",
"description": "The version number of the debit memo PDF file.\n"
}
}
}
DebitMemoFromChargeCustomRatesType
{
"allOf": [
{
"type": "object",
"required": [
"currency",
"customFxRate"
],
"properties": {
"currency": {
"type": "string",
"description": "The currency code for either Reporting or Home currency.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"rateDate": {
"type": "string",
"format": "date",
"description": "The date on which a particular currency rate is fixed or obtained on.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"customFxRate": {
"type": "number",
"format": "decimal",
"description": "The Custom FX conversion rate between home currency and transactional currency items.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
}
}
},
{
"$ref": "#/components/schemas/DebitMemoItemObjectCustomFields"
}
],
"title": "customRates"
}
DebitMemoFromChargeDetailType
{
"allOf": [
{
"type": "object",
"required": [
"chargeId",
"productRatePlanChargeId"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the debit memo item.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"comment": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "Comments about the product rate plan charge.\n\n**Note**: This field is not available if you set the `zuora-version` request header to `257.0` or before.\n"
},
"chargeId": {
"type": "string",
"description": "The ID of the product rate plan charge that the debit memo is created from.\n\n**Note**: This field is not available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "The number of units for the debit memo item.\n"
},
"description": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "The description of the product rate plan charge.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"memoItemAmount": {
"type": "number",
"format": "double",
"description": "The amount of the debit memo item.\n\n**Note**: This field is not available if you set the `zuora-version` request header to `224.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The service end date of the debit memo item. If not specified, the effective end date of the corresponding product rate plan will be used.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The service start date of the debit memo item. If not specified, the effective start date of the corresponding product rate plan will be used.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"revenueRecognitionRuleName": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n"
}
},
"description": "Container for the finance information related to the product rate plan charge associated with the debit memo.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of the product rate plan charge that the debit memo is created from.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude the debit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/DebitMemoItemObjectCustomFields"
}
],
"title": "charges"
}
DebitMemoFromChargeRequest
{
"allOf": [
{
"type": "object",
"properties": {
"autoPay": {
"type": "boolean",
"description": "Whether debit memos are automatically picked up for processing in the corresponding payment run. \n\nBy default, debit memos are automatically picked up for processing in the corresponding payment run.\n"
},
"charges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DebitMemoFromChargeDetailType"
},
"maxItems": 1000,
"description": "Container for product rate plan charges. The maximum number of items is 1,000.\n"
},
"comment": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "Comments about the debit memo.\n"
},
"dueDate": {
"type": "string",
"format": "date",
"description": "The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format.\n"
},
"autoPost": {
"type": "boolean",
"default": false,
"description": "Whether to automatically post the debit memo after it is created. \n\nSetting this field to `true`, you do not need to separately call the [Post a debit memo](https://developer.zuora.com/api-references/api/operation/PUT_PostDebitMemo) operation to post the debit memo.\n"
},
"currency": {
"type": "string",
"description": "The code of a currency as defined in Billing Settings through the Zuora UI.\n\nIf you do not specify a currency during debit memo creation, the default account currency is applied. The currency that you specify in the request must be configured and activated in Billing Settings.\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currencies</a> feature enabled.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with the debit memo.\n\n**Note**: When creating debit memos from product rate plan charges, you must specify `accountNumber`, `accountId`, or both in the request body. If both fields are specified, they must correspond to the same account.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n"
},
"customRates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DebitMemoFromChargeCustomRatesType"
},
"maxItems": 2,
"description": "It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both).\n\n**Note**: The API custom rate feature is permission controlled.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the account associated with the debit memo.\n\n**Note**: When creating debit memos from product rate plan charges, you must specify `accountNumber`, `accountId`, or both in the request body. If both fields are specified, they must correspond to the same account.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the debit memo takes effect.\n"
}
}
},
{
"$ref": "#/components/schemas/DebitMemoObjectNSFields"
},
{
"$ref": "#/components/schemas/DebitMemoObjectCustomFields"
}
],
"title": "memos",
"example": {
"autoPay": true,
"charges": [
{
"amount": 30,
"comment": "this is comment1",
"chargeId": "402890555a87d7f5015a892cae910050",
"quantity": 1
},
{
"amount": 20,
"comment": "this is comment2",
"chargeId": "402890555a87d7f5015a892dff7f0053"
}
],
"comment": "the comment",
"autoPost": false,
"currency": "USD",
"accountId": "402890555a7e9791015a7f15fe44001c",
"reasonCode": "Correcting invoice error",
"customRates": [
{
"currency": "CAD",
"rateDate": "2022-10-21",
"customFxRate": 2.22
},
{
"currency": "EUR",
"rateDate": "2022-10-21",
"customFxRate": 2.22
}
],
"effectiveDate": "2017-10-17"
}
}
DebitMemoFromInvoiceRequest
{
"allOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DebitMemoItemFromInvoiceItemType"
},
"maxItems": 1000,
"description": "Container for items. The maximum number of items is 1,000.\n"
},
"autoPay": {
"type": "boolean",
"description": "Whether debit memos are automatically picked up for processing in the corresponding payment run. \nBy default, debit memos are automatically picked up for processing in the corresponding payment run.\n"
},
"comment": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "Comments about the debit memo. \n"
},
"autoPost": {
"type": "boolean",
"default": false,
"description": "Whether to automatically post the debit memo after it is created. \nSetting this field to `true`, you do not need to separately call the [Post debit memo](https://developer.zuora.com/api-references/api/operation/PUT_PostDebitMemo) operation to post the debit memo.\n"
},
"invoiceId": {
"type": "string",
"description": "The ID of the invoice that the debit memo is created from.\n* If this field is specified, its value must be the same as the value of the `invoiceId` path parameter. Otherwise, its value overrides the value of the `invoiceId` path parameter. \n* If this field is not specified, the value of the `invoiceId` path parameter is used. \n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the debit memo takes effect.\n"
},
"taxAutoCalculation": {
"type": "boolean",
"default": true,
"description": "Whether to automatically calculate taxes in the debit memo.\n"
}
}
},
{
"$ref": "#/components/schemas/DebitMemoObjectNSFields"
},
{
"$ref": "#/components/schemas/DebitMemoObjectCustomFields"
}
],
"title": "memos",
"example": {
"items": [
{
"amount": 1,
"comment": "This is comment!",
"skuName": "SKU-30",
"taxMode": "TaxExclusive",
"autoPost": false,
"quantity": 1,
"taxItems": [
{
"amount": 0.01,
"taxCode": null,
"taxDate": "2017-11-30",
"taxName": "STATE TAX",
"taxRate": 0.0625,
"taxRateType": "Percentage",
"jurisdiction": "CALIFORNIA",
"locationCode": "06",
"sourceTaxItemId": "402890555a7d4022015a7dadb39b00a1",
"taxExemptAmount": 0,
"taxCodeDescription": null,
"taxRateDescription": "This is tax rate description!"
}
],
"invoiceItemId": "402890555a7d4022015a7dadb3b700a6",
"unitOfMeasure": "Test_UOM",
"serviceEndDate": "2017-11-30",
"serviceStartDate": "2017-11-01"
}
],
"autoPay": true,
"comment": "the comment",
"reasonCode": "Charge Dispute",
"effectiveDate": "2017-11-30"
}
}
DebitMemoItemFromInvoiceItemType
{
"allOf": [
{
"type": "object",
"required": [
"skuName",
"amount"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the debit memo item.\n"
},
"comment": {
"type": "string",
"description": "Comments about the debit memo item.\n**Note**: This field is not available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"skuName": {
"type": "string",
"description": "The name of the charge associated with the invoice.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive"
],
"type": "string",
"default": "TaxExclusive",
"description": "The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax.\n\n**Note**: You can set this field to `TaxInclusive` only if the `taxAutoCalculation` field is set to `true`.\n\nIf you set `taxMode` to `TaxInclusive`, you cannot input tax amounts for debit memo items. The corresponding invoice item must use the same tax engine as the debit memo item to calculate tax amounts.\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "The number of units for the debit memo item.\n"
},
"taxItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DebitMemoTaxItemFromInvoiceTaxItemType"
},
"description": "Container for taxation items.\n"
},
"description": {
"type": "string",
"description": "The description of the debit memo item.\n**Note**: This field is only available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the invoice item.\n"
},
"unitOfMeasure": {
"type": "string",
"description": "The definable unit that you measure when determining charges.\n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The service end date of the debit memo item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The service start date of the debit memo item. \n"
},
"financeInformation": {
"type": "object",
"properties": {
"revenueRecognitionRuleName": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n"
}
},
"description": "Container for the finance information related to the debit memo item.\n"
}
}
},
{
"$ref": "#/components/schemas/DebitMemoItemObjectCustomFields"
}
],
"title": "items"
}
DebitMemoItemObjectCustomFields
{
"type": "object",
"title": "debitMemoItemFieldsCustom",
"description": "Container for custom fields of a Debit Memo Item object.\n",
"additionalProperties": {
"description": "Custom fields of the Debit Memo Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
DebitMemoObjectCustomFields
{
"type": "object",
"title": "debitMemoFieldsCustom",
"description": "Container for custom fields of a Debit Memo object.\n",
"additionalProperties": {
"description": "Custom fields of the Debit Memo object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
DebitMemoObjectCustomFieldsCMWriteOff
{
"type": "object",
"title": "debitMemoFieldsCustom",
"description": "Container for custom fields of a Debit Memo object.\n",
"additionalProperties": {
"description": "Custom fields of the Debit Memo object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
DebitMemoObjectNSFields
{
"type": "object",
"title": "debitMemoFieldsNS",
"properties": {
"SyncDate__NS": {
"type": "string",
"maxLength": 255,
"description": "Date when the debit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationId__NS": {
"type": "string",
"maxLength": 255,
"description": "ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationStatus__NS": {
"type": "string",
"maxLength": 255,
"description": "Status of the debit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
},
"description": "Container for Debit Memo fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
DebitMemoTaxItemFromInvoiceTaxItemType
{
"type": "object",
"title": "taxItems",
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the debit memo taxation item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific debit memo.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date that the tax is applied to the debit memo, in `yyyy-mm-dd` format.\n"
},
"taxName": {
"type": "string",
"description": "The name of taxation.\n"
},
"taxRate": {
"type": "number",
"format": "double",
"description": "The tax rate applied to the debit memo.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate applied to the debit memo.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field.\n"
},
"sourceTaxItemId": {
"type": "string",
"description": "The ID of the source taxation item.\n"
},
"taxExemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"salesTaxPayableAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the sales taxes payable.\n"
}
},
"description": "Container for the finance information related to the source taxation item.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
}
}
}
DebitTaxationItemObjectCustomFields
{
"type": "object",
"title": "debitTaxationItemFieldsCustom",
"description": "Container for custom fields of a Debit Taxation Item object.\n",
"additionalProperties": {
"description": "Custom fields of the Debit Taxation Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
DeleteAccountResponseType
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the deleted account.\n"
},
"jobId": {
"type": "string",
"description": "The ID of the job that handles the account deletion operation. \n\nYou can specify the value of this field as the value of the `jobId` path parameter in the [Retrieve an operation job](https://developer.zuora.com/api-references/api/operation/GET_OperationJob/) API operation to query job information.\n"
},
"reasons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The error code of the response.\n"
},
"message": {
"type": "string",
"description": "The detail information of the error response.\n"
}
}
}
},
"success": {
"type": "boolean",
"description": "Whether the call succeeded.\n"
},
"jobStatus": {
"enum": [
"Pending"
],
"type": "string",
"description": "The status of the account deletion operation. \n"
}
}
}
DeleteBatchQueryJobResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The job ID created for the AQuA API request. The job ID can be used for querying for the query status. \n\nThe ID exists only if the JSON request can be parsed and validated successfully. Otherwise, the job ID is null.\n"
},
"name": {
"type": "string",
"description": "The name of the job. 32 character limit.\n"
},
"format": {
"enum": [
"csv",
"zip",
"gzip"
],
"type": "string",
"description": "The format of the query. The default value is `csv`.\n"
},
"status": {
"enum": [
"submitted",
"executing",
"completed",
"error",
"aborted",
"cancelled"
],
"type": "string",
"description": "The status of the AQuA job:\n- submitted: The AQuA job was submitted to the query executor for processing.\n- executing: The AQuA job is being processed.\n- completed: The AQuA job was successfully executed.\n- error: The AQuA job was not processed because of validation errors.\n- aborted: The AQuA job execution failed because one or more queries of this job failed.\n- cancelled: The AQuA job was cancelled.\n"
},
"batches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchQueries"
},
"required": [
"name",
"query",
"status",
"batchId",
"batchType"
],
"description": "A JSON array object that contains a list of batch objects.\n"
},
"version": {
"type": "number",
"format": "float",
"description": "The API version you want to use. \n\nThe supported versions are as follows:\n - `1.1`. It supports both modes\n - `1.0`. Default. It supports stateless modes only.\n\nSee <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/BA_Stateless_and_Stateful_Modes\" target=\"_blank\">Stateless and stateful modes</a> for more information.\n"
},
"sourceData": {
"type": "string",
"description": "Indicates the source this aggregate query runs against:\n\n* `LIVE` represents the live transactional databases at Zuora (Data Query Live).\n\n* `WAREHOUSE` represents Zuora Warehouse, which has better performance and fewer limitations than the live transactional database. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_Warehouse/A_Zuora_Warehouse_overview\" target=\"_blank\">Zuora Warehouse</a>.\n"
}
}
}
DeleteCustomObjectDefinitionByTypeResponse
{
"type": "string",
"format": "uri",
"example": "/objects/definitions/default/test_custom_object",
"description": "The URI of the deleted custom object definition"
}
DeleteCustomObjectRecordByIdResponse
{
"type": "string",
"format": "uri",
"example": "/objects/records/default/test_custom_object/3a437f0b-fa7a-45bf-a9a5-2187a5a13ec0",
"description": "The URI of the deleted custom object record."
}
DeleteDataQueryJobResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DataQueryJobCancelled"
}
}
}
DeleteInvoiceResponseType
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the deleted invoice.\n"
},
"jobId": {
"type": "string",
"description": "The ID of the job that handles the invoice deletion operation. \n\nYou can specify the value of this field as the value of the `jobId` path parameter in the [Retrieve an operation job](https://developer.zuora.com/api-references/api/operation/GET_OperationJob/) API operation to query job information.\n"
},
"reasons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The error code of the response.\n"
},
"message": {
"type": "string",
"description": "The detail information of the error response.\n"
}
}
}
},
"success": {
"type": "boolean",
"description": "Whether the call succeeded.\n"
},
"jobStatus": {
"enum": [
"Pending",
"Completed"
],
"type": "string",
"description": "The status of the invoice deletion operation. \n"
}
}
}
DeleteResult
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the deleted object.\n"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionsErrorResponse"
},
"description": "If the delete failed, this contains an array of Error objects.\n"
},
"success": {
"type": "boolean",
"description": "A boolean field indicating the success of the delete operation. If the delete was successful, it is `true`. Otherwise, `false`.\n"
}
}
}
DeleteWorkflowError
{
"type": "object",
"properties": {
"Errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "The error messages"
}
}
}
DeleteWorkflowSuccess
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the deleted workflow"
},
"success": {
"type": "boolean",
"description": "The indicator for whether the deletion was a success"
}
}
}
DeliveryScheduleParams
{
"type": "object",
"properties": {
"friday": {
"type": "boolean",
"description": "Indicates whether delivery on friday.\n"
},
"monday": {
"type": "boolean",
"description": "Indicates whether delivery on monday.\n"
},
"sunday": {
"type": "boolean",
"description": "Indicates whether delivery on sunday.\n"
},
"tuesday": {
"type": "boolean",
"description": "Indicates whether delivery on tuesday.\n"
},
"saturday": {
"type": "boolean",
"description": "Indicates whether delivery on saturday.\n"
},
"thursday": {
"type": "boolean",
"description": "Indicates whether delivery on thursday.\n"
},
"frequency": {
"enum": [
"Weekly"
],
"type": "string",
"description": "Specifies the frequency for delivery schedule\n"
},
"wednesday": {
"type": "boolean",
"description": "Indicates whether delivery on wednesday.\n"
}
}
}
DeploymentManagerResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the Deployment Manager migration process"
},
"status": {
"enum": [
"DEPLOYING",
"REVERTING",
"PARTIALLY-REVERTED",
"FAILED",
"ROLLBACK-FAILED",
"REVERTED",
"COMPARING",
"SUBMITTED",
"SKIPPED",
"IDENTICAL",
"COMPARE-DONE",
"COMPARE-FAILED",
"CANCELLED"
],
"type": "string",
"description": "Status of the Deployment Manager migration process"
}
}
}
DestinationValidityPeriodInfo
{
"type": "object",
"title": "destinationValidityPeriod",
"required": [
"startDate",
"endDate"
],
"properties": {
"endDate": {
"type": "string",
"format": "date",
"description": "End date of the destination validity period."
},
"startDate": {
"type": "string",
"format": "date",
"description": "Start date of the destination validity period."
}
},
"description": "Date range of the destination validity period to which the funds are transferred. It should be close to the source validity period."
}
DetailedWorkflow
{
"type": "object",
"title": "detailed workflow",
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the workflow.\n"
},
"name": {
"type": "string",
"description": "The name of the workflow.\n"
},
"type": {
"enum": [
"Workflow::Setup",
"Workflow::Instance"
],
"type": "string",
"description": "The type of the workflow. Currently the only valid value is 'Workflow::Setup'.\n"
},
"status": {
"type": "integer",
"description": "The status of the active workflow version.\n"
},
"version": {
"type": "string",
"description": "The version number of the active workflow version. \n"
},
"interval": {
"type": "string",
"description": "The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled.\n"
},
"priority": {
"type": "string",
"description": "The priority of the active workflow version. \n"
},
"timezone": {
"type": "string",
"description": "The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled.\n"
},
"call_type": {
"type": "string",
"description": "The call type of the active workflow version.\n"
},
"createdAt": {
"type": "string",
"format": "datetime",
"description": "The date and time when the workflow is created, in the `YYYY-MM-DD HH:MM:SS` format.\n"
},
"updatedAt": {
"type": "string",
"format": "datetime",
"description": "The date and time when the workflow is updated the last time, in the `YYYY-MM-DD HH:MM:SS` format.\n"
},
"started_at": {
"type": "string",
"format": "datetime",
"description": "The date and time when the instance of the workflow version started at.\n"
},
"description": {
"type": "string",
"description": "The description of the workflow.\n"
},
"finished_at": {
"type": "string",
"format": "datetime",
"description": "The date and time when the instance of the workflow version finished at.\n"
},
"sync_trigger": {
"type": "boolean",
"description": "Indicates whether the workflow version is enabled for the sync mode.\n"
},
"calloutTrigger": {
"type": "boolean",
"description": "Indicates whether the callout trigger is enabled for the retrieved workflow.\n"
},
"ondemandTrigger": {
"type": "boolean",
"description": "Indicates whether the ondemand trigger is enabled for the workflow.\n"
},
"scheduledTrigger": {
"type": "boolean",
"description": "Indicates whether the scheduled trigger is enabled for the workflow.\n"
},
"original_workflow_id": {
"type": "integer",
"description": "The unique ID of the original workflow version.\n"
}
},
"description": "A workflow.\n"
}
DiscountApplyDetail
{
"type": "object",
"title": "discountApplyDetail",
"required": [
"productRatePlanId",
"productRatePlanChargeId"
],
"properties": {
"productRatePlanId": {
"type": "string",
"description": "Product Rate Plan Id of the discount apply to.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "Product Rate Plan Charge Id of the discount apply to.\n"
}
}
}
DiscountItemObjectCustomFields
{
"type": "object",
"title": "discountItemFieldsCustom",
"description": "Container for custom fields of an Discount Item object.\n",
"additionalProperties": {
"description": "Custom fields of the Discount Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
DiscountItemObjectNSFields
{
"type": "object",
"title": "discountItemFieldsNS",
"properties": {
"SyncDate__NS": {
"type": "string",
"maxLength": 255,
"description": "Date when the invoice item was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationId__NS": {
"type": "string",
"maxLength": 255,
"description": "ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationStatus__NS": {
"type": "string",
"maxLength": 255,
"description": "Status of the invoice item's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
},
"description": "Container for discount Item fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
DiscountPricingOverride
{
"type": "object",
"title": "discount",
"properties": {
"discountClass": {
"type": "string",
"description": "The discount class defines the sequence in which discount product rate plan charges are applied.\n\n**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.\n"
},
"discountLevel": {
"enum": [
"rateplan",
"subscription",
"account"
],
"type": "string",
"description": "Application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge.\n"
},
"discountAmount": {
"type": "number",
"description": "Only applicable if the discount charge is a fixed-amount discount.\n"
},
"applyDiscountTo": {
"enum": [
"ONETIME",
"RECURRING",
"USAGE",
"ONETIMERECURRING",
"ONETIMEUSAGE",
"RECURRINGUSAGE",
"ONETIMERECURRINGUSAGE"
],
"type": "string",
"description": "Specifies which type of charge the discount charge applies to.\n"
},
"priceChangeOption": {
"enum": [
"NoChange",
"UseLatestProductCatalogPricing"
],
"type": "string",
"description": "Specifies how Zuora changes the price of the charge each time the subscription renews.\n"
},
"discountPercentage": {
"type": "number",
"description": "Only applicable if the discount charge is a percentage discount.\n"
},
"discountApplyDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DiscountApplyDetail"
},
"description": "Charge list of discount be applied to.\n\n**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.\n"
},
"originalDiscountAmount": {
"type": "number",
"description": "The manufacturer's suggested retail discount price for standalone charge.\n\nOnly applicable if the standalone discount charge is a fixed-amount discount.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"originalDiscountPercentage": {
"type": "number",
"description": "The manufacturer's suggested retail discount percentage for standalone charge.\n\nOnly applicable if the standalone discount charge is a percentage discount.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"applyToBillingPeriodPartially": {
"type": "boolean",
"description": "Allow the discount duration to be aligned with the billing period partially.\n\n**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.\n"
}
},
"description": "Pricing information about a discount charge.\n"
}
DiscountPricingUpdate
{
"type": "object",
"properties": {
"discountLevel": {
"enum": [
"rateplan",
"subscription",
"account"
],
"type": "string",
"description": "Application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge.\n"
},
"applyDiscountTo": {
"enum": [
"ONETIME",
"RECURRING",
"USAGE",
"ONETIMERECURRING",
"ONETIMEUSAGE",
"RECURRINGUSAGE",
"ONETIMERECURRINGUSAGE"
],
"type": "string",
"description": "Specifies which type of charge the discount charge applies to.\n"
},
"priceChangeOption": {
"enum": [
"NoChange",
"UseLatestProductCatalogPricing"
],
"type": "string",
"description": "Specifies how Zuora changes the price of the charge each time the subscription renews.\n"
},
"discountPercentage": {
"type": "number",
"description": "The amount of the discount as a percentage. This field is only used for percentage discounts.\n"
}
}
}
DocumentList
{
"type": "object",
"example": {
"docType": "Invoice",
"objectIds": [
"402880de8ce7edc3018ce7f18404315a",
"402880de8ce7edc3018ce7f18e0b3804"
]
},
"properties": {
"docType": {
"enum": [
"Invoice",
"CreditMemo",
"DebitMemo"
],
"type": "string",
"description": "The type of billing document."
},
"objectIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The collection of billing document IDs."
}
}
}
EndConditions
{
"type": "object",
"title": "endDate",
"properties": {
"upToPeriods": {
"type": "integer",
"description": "Duration of the charge in billing periods, days, weeks, months, or years, depending on the value of the `upToPeriodsType` field. Only applicable if the value of the `endDateCondition` field is `Fixed_Period`.\n"
},
"endDatePolicy": {
"enum": [
"AlignToApplyToCharge",
"SpecificEndDate",
"FixedPeriod"
],
"type": "string",
"description": "End date policy of the discount charge to become active when the **Apply to billing period partially** checkbox is selected from the product catalog UI or the `applyToBillingPeriodPartially` field is set as true from the \"CRUD: Create a product rate plan charge\" operation. \n\n- If the value of this field is `FixedPeriod`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields.\n- If the value of this field is `SpecificEndDate`, use the `specificEndDate` field to specify the date when the charge becomes inactive.\n\n**Notes**: \n- You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.\n- You can use either `endDateCondition` or `endDatePolicy` to define when a discount charge ends, but not both at the same time.\n"
},
"specificEndDate": {
"type": "string",
"format": "date",
"description": "Date in YYYY-MM-DD format. Only applicable if the value of the `endDateCondition` field is `Specific_End_Date`.\n"
},
"upToPeriodsType": {
"enum": [
"Billing_Periods",
"Days",
"Weeks",
"Months",
"Years"
],
"type": "string",
"description": "Unit of time that the charge duration is measured in. Only applicable if the value of the `endDateCondition` field is `Fixed_Period`.\n"
},
"endDateCondition": {
"enum": [
"Subscription_End",
"Fixed_Period",
"Specific_End_Date"
],
"type": "string",
"description": "Condition for the charge to become inactive.\n\n- If the value of this field is `Fixed_Period`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields.\n- If the value of this field is `Specific_End_Date`, use the `specificEndDate` field to specify the date when the charge becomes inactive.\n"
}
},
"description": "Specifies when a charge becomes inactive.\n"
}
Error401
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "Int32",
"example": 7101251
},
"message": {
"type": "string",
"example": "Unauthorized Action"
}
}
}
ErrorResponse
{
"type": "object",
"example": {
"reasons": [
{
"code": "ObjectNotFound",
"message": "Notification definition with id 6e569e1e05f040eda51a927b140c0ac1 does not exist"
}
]
},
"properties": {
"reasons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The error code of response.\n"
},
"message": {
"type": "string",
"description": "The detail information of the error response"
}
}
}
}
}
}
ErrorResponse401Record
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "Int32",
"example": 7101251
},
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error401"
},
"example": [
{
"code": "7101251X",
"message": "Unauthorized to view object record."
}
]
},
"message": {
"type": "string",
"example": "Unauthorized to process object record."
}
}
}
EventTrigger
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"active": {
"type": "boolean",
"description": "The status of the trigger."
},
"condition": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "The JEXL expression to be evaluated against object changes. See above for more information and an example."
},
"eventType": {
"$ref": "#/components/schemas/EventType"
},
"baseObject": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "The base object that the trigger rule 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__<custom_object_api_name>`. For example, `default__vehicle`.\n"
},
"description": {
"type": "string",
"maxLength": 1000,
"description": "The description of the trigger."
}
}
}
EventType
{
"type": "object",
"required": [
"name",
"displayName"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The name of the event. Should be unique, contain no space, and be in the pattern: ^[A-Za-z]{1,}[\\\\w\\\\-]*$"
},
"description": {
"type": "string",
"maxLength": 1000,
"description": "The description of the event type."
},
"displayName": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "The display name for the event type."
}
}
}
ExecuteInvoiceScheduleBillRunResponse
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the bill run.\n"
},
"status": {
"enum": [
"Pending",
"Processing",
"Completed",
"Error",
"Canceled",
"Posted",
"PostInProgress",
"CancelInProgress",
"RemoveInProgress",
"Paused"
],
"type": "string",
"description": "The status of the bill run.\n"
},
"batches": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of the batches of accounts for this bill run. \n\nThis field cannot exist with the `billRunFilters` field.\n\n**Values:** `AllBatches` or Batch*n* where *n* is a number between 1 and 50, for example, `Batch7`.\n"
},
"autoPost": {
"type": "boolean",
"description": "Whether to automatically post the bill run after the bill run is created.\n"
},
"autoEmail": {
"type": "boolean",
"description": "Whether to automatically send an email after Auto-Post is complete.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for this bill run, only valid for ad-hoc bill run.\n"
},
"autoRenewal": {
"type": "boolean",
"description": "Whether to automatically renew auto-renew subscriptions that are up for renewal.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the user who created the bill run.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the bill run was created.\n"
},
"invoiceDate": {
"type": "string",
"format": "date",
"description": "The invoice date for this bill run, only valid for ad-hoc bill runs.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the user who updated the bill run.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the bill run was updated.\n"
},
"billCycleDay": {
"type": "string",
"description": "The day of the bill cycle, this field is only valid when `batches` is specified.\n\n**Values:** \n- `AllBillCycleDays` or 1 - 31 for an ad-hoc bill run \n- `AllBillCycleDays` or 1 - 31 or `AsRunDay` for a scheduled bill run\n"
},
"billRunNumber": {
"type": "string",
"description": "The number of bill run.\n"
},
"billRunFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillRunFilters"
},
"description": "A list of the target account or subscriptions for this bill run.\n\nThis field cannot exist with the `batches` field.\n"
},
"targetDateOffset": {
"type": "integer",
"description": "The offset compared to bill run execution date, only valid for scheduled bill run.\n"
},
"invoiceDateOffset": {
"type": "integer",
"description": "The offset compared to bill run execution date, only valid for scheduled bill runs.\n"
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled. \n"
},
"chargeTypeToExclude": {
"type": "array",
"items": {
"enum": [
"OneTime",
"Recurring",
"Usage"
],
"type": "string"
},
"description": "The types of the charges to be excluded from the generation of billing documents.\n"
},
"scheduledExecutionTime": {
"type": "string",
"format": "date-time",
"description": "The scheduled execution time for a bill run.\n"
},
"noEmailForZeroAmountInvoice": {
"type": "boolean",
"description": "Whether to suppress emails for invoices with the total amount of zero or not for this bill run after the bill run is complete. \n\n**Note**: Do not email invoices with the total amount of zero.\n"
}
}
},
{}
],
"example": {
"id": "2c9890077e8a8490017e8bf3a5171a43",
"status": "Pending",
"success": true,
"autoPost": false,
"autoEmail": false,
"targetDate": "2020-02-01",
"autoRenewal": false,
"createdById": "ff808081298c6e5401298c7274a40005",
"createdDate": "2022-01-24 19:58:27",
"invoiceDate": "2020-02-01",
"updatedById": "ff808081298c6e5401298c7274a40005",
"updatedDate": "2022-01-24 19:58:27",
"billRunNumber": "BR-00000016",
"billRunFilters": [
{
"accountId": "2c9081a03c63c94c013c66688a2c00bf",
"filterType": "Subscription",
"subscriptionId": "402882297e387c51017e38a245c313db"
}
],
"chargeTypeToExclude": [
"OneTime",
"Usage"
],
"noEmailForZeroAmountInvoice": false
}
}
ExpandedAccount
{
"type": "object",
"title": "QueryAccountResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the account.\n"
},
"mrr": {
"type": "number",
"description": "Monthly recurring revenue for the account.\n"
},
"name": {
"type": "string",
"description": "The name of the account.\n"
},
"batch": {
"type": "string",
"description": "The alias name given to a batch. A string of 50 characters or less.\n"
},
"crmId": {
"type": "string",
"maxLength": 100,
"description": "External identifier of the account in a CRM system.\n"
},
"notes": {
"type": "string",
"description": "A string of up to 65,535 characters.\n"
},
"vATId": {
"type": "string",
"description": "EU Value Added Tax ID."
},
"billTo": {
"$ref": "#/components/schemas/ExpandedContact"
},
"soldTo": {
"$ref": "#/components/schemas/ExpandedContact"
},
"status": {
"enum": [
"Active",
"Draft",
"Canceled"
],
"type": "string",
"description": "The account status.\n"
},
"usages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedUsageOnExpand"
}
},
"autoPay": {
"type": "boolean",
"description": "Indicates whether future payments are automatically collected when they are due\nduring a payment run.\n"
},
"balance": {
"type": "number",
"format": "double",
"description": "The customer's total invoice balance minus credit balance.\n"
},
"refunds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedRefundOnExpand"
}
},
"billToId": {
"type": "string",
"description": "The unique identifier of the bill-to contact associated with the account.\n"
},
"currency": {
"type": "string",
"description": "A currency defined in the web-based UI administrative settings.\n"
},
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedInvoiceOnExpand"
}
},
"parentId": {
"type": "string",
"description": "Identifier of the parent customer account for this Account object. The\nlength is 32 characters. Use this field if you have <a\nhref=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\"\ntarget=\"_blank\">Customer Hierarchy</a> enabled.\n"
},
"payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedPaymentOnExpand"
}
},
"soldToId": {
"type": "string",
"description": "The unique identifier of the sold-to contact associated with the account.\n"
},
"debitMemos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedDebitMemoOnExpand"
}
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the account.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the account was created.\n"
},
"creditMemos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedCreditMemoOnExpand"
}
},
"paymentTerm": {
"type": "string",
"description": "A payment-terms indicator defined in the web-based UI administrative\nsettings, for example, `Net 30`.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the account.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the account was last updated.\n"
},
"billCycleDay": {
"type": "integer",
"format": "int64",
"description": "Billing cycle day (BCD), the day of the month when a bill run\ngenerates invoices for the account.\n"
},
"salesRepName": {
"type": "string",
"description": "Name of the account's sales representative, if applicable.\n"
},
"accountNumber": {
"type": "string",
"description": "The account number that identifies the account.\n"
},
"creditBalance": {
"type": "number",
"format": "double",
"description": "The current credit balance on the account.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the billing document sequence set to assign to the customer account. \nThe billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.\nIf a customer account has no assigned billing document sequence set, billing documents generated for this account adopt the prefix and starting document number from the default sequence set.\n"
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedSubscriptionOnExpand"
}
},
"organizationId": {
"type": "string",
"description": "The unique identifier of the organization to which the account belongs.\n"
},
"partnerAccount": {
"type": "boolean",
"description": "Whether the customer account is a partner, distributor, or reseller. \n\n**Note**: This field is available only if you have the <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account\"\ntarget=\"_blank\">Reseller Account</a> feature enabled.\n"
},
"paymentGateway": {
"type": "string",
"description": "The name of the payment gateway instance. If null or left unassigned,\nthe account will use the default gateway.\n"
},
"paymentMethods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedPaymentMethodOnExpand"
}
},
"taxCompanyCode": {
"type": "string",
"maxLength": 50,
"description": "Unique code that identifies a company account in Avalara. \n**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com).\n"
},
"lastInvoiceDate": {
"type": "string",
"format": "date",
"description": "Date of the most recent invoice for the account; null if no invoice has ever been generated.\n"
},
"taxExemptStatus": {
"enum": [
"No",
"Yes",
"PendingVerification"
],
"type": "string",
"default": "No",
"description": "Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax. \n"
},
"allowInvoiceEdit": {
"type": "boolean",
"default": false,
"description": "Indicates whether associated invoices can be edited.\n"
},
"bcdSettingOption": {
"enum": [
"ManualSet",
"AutoSet"
],
"type": "string",
"description": "The billing cycle day setting option for the account.\n"
},
"unappliedBalance": {
"type": "number",
"description": "Total unapplied balance in this currency.\n"
},
"eInvoiceProfileId": {
"type": "string",
"description": "ID of the e-invoice profile for this account.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "Invoice template ID, configured in Billing Settings in the Zuora UI.\n"
},
"lastMetricsUpdate": {
"type": "string",
"format": "date-time",
"description": "The date and time when account metrics are last updated, if the account is a partner account.\n\n**Note**: \n- This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account\" target=\"_blank\">Reseller Account</a> feature enabled.\n- If you ever set the `partnerAccount` field to `true` for an account, the value of `lastMetricsUpdate` field is the time when the account metrics are last updated.\n"
},
"debitMemoTemplateId": {
"type": "string",
"description": "ID of the debit memo template that is used to generate debit memos for the account.\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "The purchase order number provided by your customer for services,\nproducts, or both purchased.\n"
},
"totalInvoiceBalance": {
"type": "number",
"format": "double",
"description": "Total balance of all posted invoices.\n"
},
"creditMemoTemplateId": {
"type": "string",
"description": "ID of the credit memo template that is used to generate credit memos for the account.\n"
},
"defaultPaymentMethod": {
"$ref": "#/components/schemas/NestedPaymentMethodOnExpand"
},
"taxExemptDescription": {
"type": "string",
"maxLength": 500,
"description": "Description of the tax exemption certificate that the customer holds.\nApplicable if you use Zuora Tax or Connect tax engines.\n"
},
"totalDebitMemoBalance": {
"type": "number",
"format": "double",
"description": "Total balance of all posted debit memos.\n"
},
"communicationProfileId": {
"type": "string",
"description": "The unique identifier of the communication profile that Zuora uses when sending notifications to the account's contacts.\n"
},
"customerServiceRepName": {
"type": "string",
"maxLength": 50,
"description": "Name of the account's customer service representative, if applicable.\n"
},
"defaultPaymentMethodId": {
"type": "string",
"description": "ID of the default payment method for the account.\n"
},
"taxExemptCertificateID": {
"type": "string",
"maxLength": 32,
"description": "ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"taxExemptEffectiveDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption starts, in `YYYY-MM-DD` format. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"taxExemptEntityUseCode": {
"type": "string",
"maxLength": 64,
"description": "A unique entity use code to apply exemptions in Avalara AvaTax. See <a href=\"https://developer.avalara.com/avatax/handling-tax-exempt-customers/\" target=\"_blank\">Exempt Transactions</a> for more details.\n"
},
"taxExemptExpirationDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption expires, in `YYYY-MM-DD` format. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"additionalEmailAddresses": {
"type": "string",
"description": "An additional email addresse to receive email notifications.\n"
},
"taxExemptCertificateType": {
"type": "string",
"maxLength": 32,
"description": "Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"invoiceDeliveryPrefsEmail": {
"type": "boolean",
"description": "Indicates whether the customer wants to receive invoices through email. \n"
},
"invoiceDeliveryPrefsPrint": {
"type": "boolean",
"description": "Whether the customer wants to receive printed invoices, such as through postal mail.\n"
},
"unappliedCreditMemoAmount": {
"type": "number",
"format": "double",
"description": "The total unapplied amount of all posted credit memos in this currency.\n"
},
"taxExemptIssuingJurisdiction": {
"type": "string",
"maxLength": 32,
"description": "Jurisdiction in which the customer tax exemption certificate was issued.\n"
}
}
}
ExpandedAmendment
{
"type": "object",
"title": "QueryAmendmentResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the amendment.\n"
},
"code": {
"type": "string",
"description": "The amendment code.\n"
},
"name": {
"type": "string",
"description": "The name of the amendment.\n"
},
"type": {
"enum": [
"Cancellation",
"NewProduct",
"OwnerTransfer",
"RemoveProduct",
"Renewal",
"UpdateProduct",
"TermsAndConditions",
"ChangePlan"
],
"type": "string",
"description": "Type of the amendment.\n"
},
"status": {
"enum": [
"Draft",
"Pending Activation",
"Pending Acceptance",
"Completed"
],
"type": "string",
"description": "The status of the amendment.\n"
},
"subType": {
"enum": [
"Upgrade",
"Downgrade",
"Crossgrade",
"PlanChanged"
],
"type": "string",
"description": "The sub type for the change plan order action.\n\nIf this field was not set by user, the field is automatically generated by the system according to the following rules:\n\nWhen the old and new rate plans are within the same Grading catalog group:\n* If the grade of new plan is greater than that of the old plan, this is an \"Upgrade\".\n* If the grade of new plan is less than that of the old plan, this is a \"Downgrade\".\n* If the grade of new plan equals that of the old plan, this is a \"Crossgrade\".\n\nWhen the old and new rate plans are not in the same Grading catalog group, or either has no group, this is \"PlanChanged\".\n"
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN"
],
"type": "string",
"description": "Indicates if the subscription is termed or evergreen.\n"
},
"autoRenew": {
"type": "boolean",
"description": "Indicates whether the amendment is automatically renewed.\n"
},
"resumeDate": {
"type": "string",
"format": "date",
"description": "The date when the subscription resumption takes effect, as `yyyy-mm-dd`.\n\n**Note:** 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"
},
"bookingDate": {
"type": "string",
"format": "date"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the amendment.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the amendment gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"currentTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the current subscription term.\n"
},
"description": {
"type": "string",
"description": "Description of the amendment.\n"
},
"renewalTerm": {
"type": "integer",
"format": "int64",
"description": "The term of renewal for the amended subscription.\n"
},
"suspendDate": {
"type": "string",
"format": "date",
"description": "The date when the subscription suspension takes effect, as `yyyy-mm-dd`.\n\n**Note:** 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"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the amendment.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The time that the amendment gets updated in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the amendment changes take effective.\n"
},
"newRatePlanId": {
"type": "string",
"description": "The ID of the rate plan charge on which amendment is made. Only\nthe Add or Update amendment returns a new rate plan ID.\n"
},
"termStartDate": {
"type": "string",
"format": "date",
"description": "The date when the new terms and conditions take effect.\n"
},
"renewalSetting": {
"enum": [
"RENEW_WITH_SPECIFIC_TERM",
"RENEW_TO_EVERGREEN"
],
"type": "string",
"description": "Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed.\n"
},
"subscriptionId": {
"type": "string",
"description": "The ID of the subscription based on which the amendment is created.\n"
},
"effectivePolicy": {
"enum": [
"EffectiveImmediately",
"EffectiveEndOfBillingPeriod",
"SpecificDate"
],
"type": "string",
"description": "Effective Policy for the subscription. \n\nThe value depends on the following conditions:\n* If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default.\n* If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default.\n* Otherwise, the effective policy is `SpecificDate` by default.\n\n**Note:** This 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. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).\n"
},
"removedRatePlanId": {
"type": "string",
"description": "The ID of the rate plan charge that is removed from the subscription. Only\nthe Remove Product amendment returns a removed rate plan ID.\n"
},
"specificUpdateDate": {
"type": "string",
"format": "date",
"description": "The date when the Update Product amendment takes effect.\n\nOnly for the Update Product amendments if there is already \na future-dated Update Product amendment on the subscription.\n"
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the amendment becomes effective for billing purposes,\nas `yyyy-mm-dd`.\n"
},
"currentTermPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"description": "The period type for the current subscription term.\n"
},
"renewalTermPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"description": "The period type for the subscription renewal term.\n"
},
"serviceActivationDate": {
"type": "string",
"format": "date",
"description": "The date when service is activated, as `yyyy-mm-dd`.\n"
},
"customerAcceptanceDate": {
"type": "string",
"format": "date",
"description": "The date when the customer accepts the amendment changes to\nthe subscription, as `yyyy-mm-dd`.\n"
}
}
}
ExpandedBillingRun
{
"type": "object",
"title": "QueryBillingRunResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the bill run.\n"
},
"name": {
"type": "string",
"description": "The name of the bill run.\n"
},
"status": {
"enum": [
"Pending",
"Processing",
"Completed",
"Error",
"Canceled",
"Posted",
"PostInProgress",
"CancelInProgress",
"RemoveInProgress",
"Paused"
],
"type": "string",
"description": "The status of the bill run.\n"
},
"batches": {
"type": "array",
"items": {
"type": "string"
},
"description": "The batch of accounts for this bill run, this field can not exist with\n`billRunFilters` together.\n\n**Values:** `AllBatches` or an array of `Batch`*n* where *n* is a\nnumber between 1 and 50, for example, `Batch7`.\n"
},
"endDate": {
"type": "string",
"format": "date-time",
"description": "The end date and time when the bill run completes.\n"
},
"runTime": {
"type": "integer",
"format": "int32",
"maximum": 23,
"minimum": 0,
"description": "The scheduled run time (hour) of day.\n"
},
"autoPost": {
"type": "boolean",
"description": "Whether to automatically post the bill run after the bill run is created.\n"
},
"repeatTo": {
"type": "string",
"format": "date",
"description": "The end date of of the scheduled bill run.\n"
},
"timeZone": {
"type": "string",
"description": "Timezone of the scheduled bill run.\n"
},
"accountId": {
"type": "string",
"description": "The unique identifier of the account included in the bill run.\n"
},
"autoEmail": {
"type": "boolean",
"description": "Whether to automatically send emails after Auto-Post is complete.\n"
},
"startDate": {
"type": "string",
"format": "date-time",
"description": "The start date and time of the bill run.\n"
},
"totalTime": {
"type": "integer",
"format": "int64",
"description": "The total time in milliseconds for the bill run to complete.\n"
},
"postedDate": {
"type": "string",
"description": "The date when the bill run was posted.\n"
},
"repeatFrom": {
"type": "string",
"format": "date",
"description": "The start date of the scheduled bill run.\n"
},
"repeatType": {
"enum": [
"None",
"Daily",
"Weekly",
"Monthly"
],
"type": "string",
"description": "The repeat type of the bill run.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for this bill run, only valid for ad-hoc bill runs.\n"
},
"targetType": {
"enum": [
"SingleAccount",
"AllAccount"
],
"type": "string",
"description": "The target type for this bill run.\n"
},
"autoRenewal": {
"type": "boolean",
"description": "Whether to automatically renew auto-renew subscriptions that are up for renewal.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the bill run.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the bill run was created.\n"
},
"invoiceDate": {
"type": "string",
"format": "date",
"description": "The date that appears on the invoice being created, in the `yyyy-mm-dd` format. \nThe value cannot fall in a closed accounting period.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the bill run.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the bill run was last updated.\n"
},
"weeklyOnDay": {
"enum": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri",
"Sat",
"Sun"
],
"type": "string",
"description": "The repeat day in a week.\n"
},
"billCycleDay": {
"enum": [
"AllBillCycleDays",
"AsRunDay"
],
"type": "string",
"description": "The day of the bill cycle. This field is only valid when `batches` is\nspecified.\n\n**Values:** \n\n- `AllBillCycleDays` or one of numbers 1 - 31 for an ad-hoc bill run\n\n- `AllBillCycleDays`, one of numbers 1 - 31, or `AsRunDay` for a scheduled bill run\n"
},
"errorMessage": {
"type": "string",
"description": "The error message generated by a failed billing run.\n"
},
"executedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the bill run was executed.\n"
},
"monthlyOnDay": {
"type": "string",
"description": "The repeat day in a month.\n"
},
"billingRunType": {
"enum": [
"Regular",
"CatchUp"
],
"type": "string",
"default": "Regular",
"description": "The type of the bill run. \n\n- You can use this field only if the Catch-Up Bill Run feature is\nenabled. \n\n- You must specify this field to create a catch up bill run.\n"
},
"invoicesEmailed": {
"type": "boolean",
"description": "Whether the invoices have been emailed after the bill run is complete.\n"
},
"billingRunNumber": {
"type": "string",
"description": "The number of the bill run.\n"
},
"numberOfAccounts": {
"type": "integer",
"format": "int64",
"description": "The number of accounts included in this bill run processing.\n"
},
"numberOfInvoices": {
"type": "integer",
"format": "int64",
"description": "The number of invoices generated from this bill run.\n"
},
"targetDateOffSet": {
"type": "integer",
"format": "int32",
"description": "The offset compared to bill run execution date, only valid for scheduled bill runs.\n"
},
"invoiceDateOffSet": {
"type": "integer",
"format": "int32",
"description": "The offset compared to bill run execution date, only valid for scheduled bill runs.\n"
},
"lastEmailSentTime": {
"type": "string",
"format": "date-time",
"description": "The date and time when the last email was sent.\n"
},
"chargeTypeToExclude": {
"enum": [
"OneTime",
"Recurring",
"Usage"
],
"type": "string",
"description": "The types of the charges to be excluded from the generation of billing\ndocuments.\n"
},
"numberOfCreditMemos": {
"type": "integer",
"format": "int64",
"description": "The number of credit memos generated from this bill run.\n"
},
"scheduledExecutionTime": {
"type": "string",
"format": "date-time",
"description": "The scheduled execution time for a bill run.\n"
},
"noEmailForZeroAmountInvoice": {
"type": "boolean",
"description": "Whether to suppress emails for invoices with zero total amount\ngenerated in this bill run after the bill run is complete. \n"
}
}
}
ExpandedContact
{
"type": "object",
"title": "QueryContactResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the contact.\n"
},
"fax": {
"type": "string",
"maxLength": 40,
"description": "The contact's fax number. \n"
},
"city": {
"type": "string",
"maxLength": 40,
"description": "The city of the contact's address.\n"
},
"state": {
"type": "string",
"maxLength": 40,
"description": "The state or province of the contact's address.\n"
},
"county": {
"type": "string",
"maxLength": 32,
"description": "The county. May optionally be used by Zuora Tax to calculate county tax.\n"
},
"country": {
"type": "string",
"maxLength": 64,
"description": "The country of the contact's address.\n"
},
"address1": {
"type": "string",
"maxLength": 255,
"description": "The first line of the contact's address, which is often a street address or business name.\n"
},
"address2": {
"type": "string",
"maxLength": 255,
"description": "The second line of the contact's address.\n"
},
"lastName": {
"type": "string",
"maxLength": 100,
"description": "The contact's last name.\n"
},
"nickname": {
"type": "string",
"maxLength": 100,
"description": "A nickname for the contact.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with the contact.\n"
},
"firstName": {
"type": "string",
"maxLength": 100,
"description": "The contact's first name.\n"
},
"homePhone": {
"type": "string",
"maxLength": 40,
"description": "The contact's home phone number.\n"
},
"taxRegion": {
"type": "string",
"maxLength": 32,
"description": "If using Zuora Tax, a region string as optionally defined in your tax rules. \n"
},
"workEmail": {
"type": "string",
"maxLength": 74,
"description": "The contact's business email address.\n"
},
"workPhone": {
"type": "string",
"maxLength": 40,
"description": "The contact's business phone number.\n"
},
"otherPhone": {
"type": "string",
"maxLength": 40,
"description": "An additional phone number for the contact.\n"
},
"postalCode": {
"type": "string",
"maxLength": 20,
"description": "ZIP code or other postal code of the contact's address.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the contact.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the contact was created.\n"
},
"description": {
"type": "string",
"maxLength": 100,
"description": "A description for the contact.\n"
},
"mobilePhone": {
"type": "string",
"maxLength": 100,
"description": "The mobile phone number of the contact.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the contact.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the contact was last updated.\n"
},
"personalEmail": {
"type": "string",
"maxLength": 74,
"description": "The contact's personal email address.\n"
},
"otherPhoneType": {
"enum": [
"Work",
"Mobile",
"Home",
"Other"
],
"type": "string",
"description": "The type of the additional phone number.\n"
}
}
}
ExpandedCreditMemo
{
"type": "object",
"title": "QueryCreditMemoResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the credit memo.\n"
},
"source": {
"enum": [
"BillRun",
"API",
"ApiSubscribe",
"ApiAmend",
"AdhocFromPrpc",
"AdhocFromInvoice"
],
"type": "string",
"description": "The source of the credit memo.\n\nPossible values:\n- `BillRun`: The credit memo is generated by a bill run.\n- `API`: The credit memo is created by calling the [Invoice and collect](https://developer.zuora.com/api-references/api/operation/POST_TransactionInvoicePayment) operation, or by calling the Orders, Order Line Items, or Fulfillments API operations.\n- `ApiSubscribe`: The credit memo is created by calling the [Create subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription) and [Create account](https://developer.zuora.com/api-references/api/operation/POST_Account) operation.\n- `ApiAmend`: The credit memo is created by calling the [Update subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription) operation.\n- `AdhocFromPrpc`: The credit memo is created from a product rate plan charge through the Zuora UI or by calling the [Create a credit memo from a charge](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc) operation.\n- `AdhocFromInvoice`: The credit memo is created from an invoice or created by reversing an invoice. You can create a credit memo from an invoice through the Zuora UI or by calling the [Create credit memo from invoice](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice) operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the [Reverse invoice](https://developer.zuora.com/api-references/api/operation/PUT_ReverseInvoice) operation.\n"
},
"status": {
"enum": [
"Draft",
"Posted",
"Canceled",
"Error",
"PendingForTax",
"Generating",
"CancelInProgress"
],
"type": "string",
"description": "The status of the credit memo.\n"
},
"account": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"balance": {
"type": "number",
"description": "The remaining balance of credit memo.\n"
},
"comment": {
"type": "string",
"description": "Comments about the credit memo.\n"
},
"currency": {
"type": "string",
"example": "USD",
"nullable": true,
"description": "The currency of the credit memo.\n\n**Note:** By default, the currency on a billing document matches the default currency set on the associated account. \nHowever, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. \nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currency</a>.\n"
},
"memoDate": {
"type": "string",
"format": "date",
"description": "The date when the credit memo takes effect, in `yyyy-mm-dd` format.\nFor example, `2024-01-01`.\n"
},
"postedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was posted, in\n`yyyy-mm-dd hh:mm:ss` format.\n"
},
"reversed": {
"type": "boolean",
"description": "Whether the credit memo is reversed.\n"
},
"sourceId": {
"type": "string",
"description": "The ID of the credit memo source.\n\nIf a credit memo is generated from a bill run, the value is the\nnumber of the corresponding bill run. Otherwise, the value is\n`null`.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the credit memo.\n"
},
"invoiceId": {
"type": "string",
"description": "The ID of a referred invoice.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of taxation.\n"
},
"taxStatus": {
"enum": [
"Complete",
"Error"
],
"type": "string",
"description": "The status of tax calculation related to the credit memo.\n\n**Note**: This field is only applicable to tax calculation by third-party tax engines.\n"
},
"memoNumber": {
"type": "string",
"description": "The unique identification number of the credit memo.\n"
},
"postedById": {
"type": "string",
"description": "The ID of the Zuora user who posted the credit memo.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value\nmust be an existing reason code or empty.\n"
},
"sourceType": {
"enum": [
"Subscription",
"Standalone",
"Invoice",
"Order",
"CreditMemo",
"Consolidation"
],
"type": "string",
"description": "The type of the credit memo source.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for the credit memo, in `yyyy-mm-dd` format. For example, `2024-01-01`.\n"
},
"taxMessage": {
"type": "string",
"description": "The message about the status of tax calculation related to the credit memo. If tax calculation fails in one credit memo, this field displays the reason for the failure.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the credit memo.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was created.\n"
},
"totalAmount": {
"type": "number",
"format": "double",
"description": "The total amount of the credit memo, including taxes.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the credit memo.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was last updated.\n"
},
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the refund on the credit memo.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the credit memo.\n"
},
"billToContact": {
"$ref": "#/components/schemas/ExpandedContact"
},
"cancelledById": {
"type": "string",
"description": "The ID of the Zuora user who cancelled the credit memo.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the credit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"discountAmount": {
"type": "number",
"description": "The amount of the discount on the credit memo.\n"
},
"einvoiceFileId": {
"type": "string",
"description": "The ID of the e-invoice file generated for the credit memo.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"einvoiceStatus": {
"enum": [
"Processing",
"Generated",
"Success",
"Failed"
],
"type": "string",
"description": "The status of the e-invoice file generation for the credit memo. \n\n- If e-invoice file generation succeeds, this field is either `Generated` or `Success`, and both the error code and message are empty, and the `eInvoiceFileId` field stores the ID of the generated e-invoice file.\n- If a failure occurs during e-invoice file generation, this field is `Failed` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the credit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"creditMemoItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedCreditMemoItemOnExpand"
}
},
"exchangeRateDate": {
"type": "string",
"format": "date",
"description": "The date of the exchange rate used. The date is in `yyyy-mm-dd` format.\nCorresponds to the value specified in the Provider Exchange Rate Date column in the Import Foreign Exchange Rates template when you uploaded the rates through the Mass Updater.\n"
},
"einvoiceErrorCode": {
"type": "string",
"description": "The error code returned when the e-invoice file status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"taxAutoCalculation": {
"type": "boolean",
"default": true,
"description": "Whether to automatically calculate taxes in the credit memo.\n"
},
"autoApplyUponPosting": {
"type": "boolean",
"description": "Whether the credit memo automatically applies to the invoice upon\nposting.\n"
},
"einvoiceErrorMessage": {
"type": "string",
"description": "The error message returned when the e-invoice file status is `Failed`. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"totalTaxExemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"totalAmountWithoutTax": {
"type": "number",
"format": "double",
"description": "The total amount of the credit memo, excluding taxes.\n"
},
"creditMemoApplications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedCreditMemoApplicationOnExpand"
}
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot associated with the credit memo.\n\nThe value of this field is `null` if the bill rule [Preserve snapshot of bill-to and sold-to contacts when billing documents are posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted) is disabled.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the\ncredit memo.\n\n**Note**: If you have the Flexible Billing Attributes feature\ndisabled, the value of this field is `null`.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the credit memo was transferred to an external\naccounting system. This field is used for integration with\naccounting systems such as NetSuite.\n"
},
"excludeFromAutoApplyRules": {
"type": "boolean",
"description": "Whether the credit memo is excluded from the rule of automatically applying credit memos to invoices.\n"
}
}
}
ExpandedCreditMemoApplication
{
"type": "object",
"title": "QueryCreditMemoApplicationResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the credit memo application.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The application amount of the credit memo.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the credit memo.\n"
},
"invoiceId": {
"type": "string",
"description": "The ID of the invoice to which the credit memo is applied.\n"
},
"creditMemo": {
"$ref": "#/components/schemas/NestedCreditMemoOnExpand"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the credit memo application.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo application was created.\n"
},
"debitMemoId": {
"type": "string",
"description": "The ID of the debit memo to which the credit memo is applied.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the credit memo application.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo application was last updated.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo associated with the credit memo application.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the credit memo application becomes effective.\n"
},
"applicationGroupId": {
"type": "string",
"description": "The ID of the application group to which this credit memo application belongs.\n"
}
}
}
ExpandedCreditMemoItem
{
"type": "object",
"title": "QueryCreditMemoItemResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the credit memo item.\n"
},
"sku": {
"type": "string",
"description": "The SKU for the product associated with the credit memo item.\n"
},
"amount": {
"type": "number",
"description": "The amount of the credit memo item. For tax-inclusive credit memo\nitems, the amount indicates the credit memo item amount including tax.\nFor tax-exclusive credit memo items, the amount indicates the credit\nmemo item amount excluding tax.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive"
],
"type": "string",
"description": "The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax.\n"
},
"itemType": {
"type": "string",
"description": "The type of the credit memo item.\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "The number of units for the credit memo item.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of the tax applied to the credit memo item.\n"
},
"unitPrice": {
"type": "number",
"format": "double",
"description": "The per-unit price of the credit memo item.\n"
},
"chargeDate": {
"type": "string",
"format": "date-time",
"description": "The date when the credit memo item is charged, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"chargeName": {
"type": "string",
"description": "The name of the charge associated with the credit memo item. \n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the credit memo item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo item was created.\n"
},
"description": {
"type": "string",
"description": "The description of the credit memo item.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"taxCodeName": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific credit memo item.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the credit memo item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo item was last updated.\n"
},
"chargeNumber": {
"type": "string",
"description": "The number of the product rate plan charge that the credit memo is created from.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo to which this credit memo item belongs.\n"
},
"subscription": {
"$ref": "#/components/schemas/NestedSubscriptionOnExpand"
},
"fulfillmentId": {
"type": "string",
"description": "The reference ID of the fulfillment associated with the credit memo item.\n"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the invoice item associated with the credit memo item.\n"
},
"unitOfMeasure": {
"type": "string",
"description": "The units to measure usage.\n"
},
"journalEntryId": {
"type": "string",
"description": "The ID of the journal entry that corresponds to this credit memo item.\n"
},
"processingType": {
"enum": [
"Charge",
"Discount"
],
"type": "string",
"description": "The type of the charge for the credit memo item. \n"
},
"ratePlanCharge": {
"$ref": "#/components/schemas/NestedRatePlanChargeOnExpand"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The service end date of the credit memo item. \n"
},
"sourceItemType": {
"enum": [
"SubscriptionComponent",
"InvoiceDetail",
"ProductRatePlanCharge",
"OrderLineItem"
],
"type": "string",
"description": "The type of the source item.\n\n- If a credit memo is not created from an invoice or a product rate plan charge or a return order line item, the value of this field is `SubscriptionComponent`. \n- If a credit memo is created from an invoice, the value of this field is `InvoiceDetail`.\n- If a credit memo is created from a product rate plan charge, the value of this field is `ProductRatePlanCharge`.\n- If a credit memo is created from a return order line item, the value of this field is `OrderLineItem`.\n \n"
},
"subscriptionId": {
"type": "string",
"description": "The ID of the subscription associated with the credit memo item.\n"
},
"appliedToItemId": {
"type": "string",
"description": "The unique ID of the credit memo item that the discount charge is applied to.\n"
},
"orderLineItemId": {
"type": "string",
"description": "The ID of the order line item associated with the credit memo item, if applicable.\n"
},
"taxExemptAmount": {
"type": "number",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"unappliedAmount": {
"type": "number",
"format": "double",
"description": "The unapplied amount of the credit memo item.\n"
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "The credit memo item amount excluding tax.\n"
},
"creditFromItemId": {
"type": "string",
"description": "The ID of the credit from item.\n"
},
"ratePlanChargeId": {
"type": "string",
"description": "The ID of the rate plan charge associated with the credit memo item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The service start date of the credit memo item.\n"
},
"invoiceScheduleId": {
"type": "string",
"description": "The ID of the invoice schedule associated with the credit memo item. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"numberOfDeliveries": {
"type": "number",
"description": "The number of deliveries dedicated to the Delivery Pricing charges. The value might be different, as follows:\n- For the credit memo generated by a bill run, this field has a value. \n- For the credit memo generated from an invoice, this field is blank.\n**Note**: This field is available only if you have the Delivery Pricing feature enabled.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "The number of the subscription associated with the credit memo item.\n"
},
"itemSoldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the credit memo item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "The purchase order number associated the credit memo item.\n"
},
"creditFromItemSource": {
"enum": [
"InvoiceItem",
"CreditMemoItem"
],
"type": "string",
"description": "The type of the credit from item.\n"
},
"appliedToOthersAmount": {
"type": "number",
"description": "The amount of the credit memo that is applied to other credit memo\nitems.\n"
},
"invoiceScheduleItemId": {
"type": "string",
"description": "The ID of the invoice schedule item associated with the credit memo item. The credit memo item is generated during the processing of the invoice schedule item.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"commitmentChargeNumber": {
"type": "string"
},
"beAppliedByOthersAmount": {
"type": "number"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot associated with the credit memo.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of the product rate plan charge that the credit memo is created\nfrom.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the credit memo.\n"
},
"onAccountAccountingCodeId": {
"type": "string",
"description": "The On Account accounting code for the credit memo item.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"itemSoldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the credit memo item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"commitmentChargeSegmentNumber": {
"type": "string"
},
"deferredRevenueAccountingCodeId": {
"type": "string",
"description": "The Deferred Revenue accounting code for the credit memo item.\n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "The Account Receivable accounting code for the credit memo item.\n"
},
"recognizedRevenueAccountingCodeId": {
"type": "string",
"description": "The Recognized Revenue accounting code for the credit memo item.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the credit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
}
ExpandedDebitMemo
{
"type": "object",
"title": "QueryDebitMemoResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the debit memo.\n"
},
"source": {
"enum": [
"BillRun",
"API",
"ApiSubscribe",
"ApiAmend",
"AdhocFromPrpc",
"AdhocFromInvoice"
],
"type": "string",
"description": "The source of the debit memo.\nPossible values:\n- `BillRun`: The debit memo is generated by a bill run.\n- `API`\n- `ApiSubscribe`: The debit memo is created by calling the [Create subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription) and [Create account](https://developer.zuora.com/api-references/api/operation/POST_Account) operation.\n- `ApiAmend`: The debit memo is created by calling the [Update subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription) operation.\n- `AdhocFromPrpc`: The debit memo is created from a product rate plan charge through the Zuora UI or by calling the [Create a debit memo from a charge](https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromPrpc/) operation.\n- `AdhocFromInvoice`: The debit memo is created from an invoice or created by reversing an invoice. You can create a debit memo from an invoice through the Zuora UI or by calling the [Create a debit memo from an invoice](https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromInvoice/) operation.\n"
},
"status": {
"enum": [
"Draft",
"Posted",
"Canceled",
"Error",
"PendingForTax",
"Generating",
"CancelInProgress"
],
"type": "string",
"description": "The status of the debit memo.\n"
},
"account": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"autoPay": {
"type": "boolean",
"description": "Whether debit memos are automatically picked up for processing in the\ncorresponding payment run.\n\n\nBy default, debit memos are automatically picked up for processing in\nthe corresponding payment run.\n"
},
"balance": {
"type": "number",
"description": "The remaining balance of debit memo.\n"
},
"dueDate": {
"type": "string",
"format": "date",
"description": "The date by which the payment for the debit memo is due, in\n`yyyy-mm-dd` format.\n"
},
"comments": {
"type": "string",
"description": "Comments about the debit memo.\n"
},
"currency": {
"type": "string",
"nullable": true,
"description": "The currency of the debit memo.\n\n**Note:** By default, the currency on a billing document matches the default currency set on the associated account. \nHowever, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. \nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currency</a>.\n"
},
"memoDate": {
"type": "string",
"format": "date",
"description": "The date when the debit memo takes effect, in `yyyy-mm-dd` format.\nFor example, `2024-01-01`.\n"
},
"postedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was posted, in\n`yyyy-mm-dd hh:mm:ss` format.\n"
},
"sourceId": {
"type": "string",
"description": "The ID of the debit memo source.\n\nIf a debit memo is generated from a bill run, the value is the\nnumber of the corresponding bill run. Otherwise, the value is\n`null`.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the debit memo.\n"
},
"invoiceId": {
"type": "string",
"description": "The ID of a referred invoice.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of taxation.\n"
},
"taxStatus": {
"enum": [
"Complete",
"Error"
],
"type": "string",
"description": "The status of tax calculation related to the debit memo.\n\n\n**Note**: This field is only applicable to tax calculation by\nthird-party tax engines.\n"
},
"memoNumber": {
"type": "string",
"description": "The unique identification number of the debit memo.\n"
},
"postedById": {
"type": "string",
"description": "The ID of the Zuora user who posted the debit memo.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value\nmust be an existing reason code or empty.\n"
},
"sourceType": {
"enum": [
"Subscription",
"Standalone",
"Order",
"Consolidation",
"Invoice",
"CreditMemo"
],
"type": "string",
"description": "The type of the debit memo source.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for the debit memo, in `yyyy-mm-dd` format. For example, `2024-01-01`.\n"
},
"taxMessage": {
"type": "string",
"description": "The message about the status of tax calculation related to the\ndebit memo. If tax calculation fails in one debit memo, this\nfield displays the reason for the failure.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the debit memo.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was created.\n"
},
"paymentTerm": {
"type": "string",
"description": "The name of the payment term assoicated with the debit memo.\n\n\nThe value of this field is `null` if you have the [Flexible Billing\nAttributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes)\nfeature disabled.\n"
},
"totalAmount": {
"type": "number",
"format": "double",
"description": "The total amount of the debit memo, including taxes.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the debit memo.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was last updated.\n"
},
"creditMemoId": {
"type": "string",
"nullable": true,
"description": "The ID of the credit memo from which the debit memo was created.\n"
},
"billToContact": {
"$ref": "#/components/schemas/ExpandedContact"
},
"cancelledById": {
"type": "string",
"description": "The ID of the Zuora user who cancelled the debit memo.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the debit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"debitMemoItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedDebitMemoItemOnExpand"
}
},
"discountAmount": {
"type": "number",
"description": "The amount of the discount on the debit memo.\n"
},
"einvoiceFileId": {
"type": "string",
"description": "The ID of the e-invoice file generated for the debit memo.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"einvoiceStatus": {
"enum": [
"Processing",
"Generated",
"Success",
"Failed"
],
"type": "string",
"description": "The status of the e-invoice file generation for the credit memo. \n\n- If e-invoice file generation succeeds, this field is either `Generated` or `Success`, and both the error code and message are empty, and the `eInvoiceFileId` field stores the ID of the generated e-invoice file.\n- If a failure occurs during e-invoice file generation, this field is `Failed` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the debit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"exchangeRateDate": {
"type": "string",
"format": "date",
"description": "The date of the exchange rate used. The date is in `yyyy-mm-dd` format.\nCorresponds to the value specified in the Provider Exchange Rate Date column in the Import Foreign Exchange Rates template when you uploaded the rates through the Mass Updater.\n"
},
"einvoiceErrorCode": {
"type": "string",
"description": "The error code returned when the e-invoice file status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"taxAutoCalculation": {
"type": "boolean",
"default": true,
"description": "Whether to automatically calculate taxes in the debit memo.\n"
},
"einvoiceErrorMessage": {
"type": "string",
"description": "The error message returned when the e-invoice file status is `Failed`. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"totalTaxExemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"totalAmountWithoutTax": {
"type": "number",
"format": "double",
"description": "The total amount of the debit memo, excluding taxes.\n"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot associated with the debit memo.\n\nThe value of this field is `null` if the bill rule [Preserve snapshot of bill-to and sold-to contacts when billing documents are posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted) is disabled.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the\ndebit memo.\n\n**Note**: If you have the Flexible Billing Attributes feature\ndisabled, the value of this field is `null`.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the debit memo was transferred to an external\naccounting system. This field is used for integration with\naccounting systems such as NetSuite.\n"
}
}
}
ExpandedDebitMemoItem
{
"type": "object",
"title": "QueryDebitMemoItemResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the debit memo item.\n"
},
"sku": {
"type": "string",
"description": "The SKU for the product associated with the debit memo item.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax.\n"
},
"balance": {
"type": "number",
"format": "double",
"description": "The balance of the debit memo item.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive"
],
"type": "string",
"description": "The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax.\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "The number of units for the debit memo item.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of tax on this debit memo.\n"
},
"unitPrice": {
"type": "number",
"format": "double",
"description": "The per-unit price of the debit memo item.\n"
},
"chargeDate": {
"type": "string",
"format": "date-time",
"description": "The date when the debit memo item is charged, in `yyyy-mm-dd hh:mm:ss`\nformat.\n"
},
"chargeName": {
"type": "string",
"description": "The name of the charge associated with the debit memo item.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the debit memo item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo item was created.\n"
},
"debitMemoId": {
"type": "string",
"description": "The ID of the debit memo to which this debit memo item belongs.\n"
},
"description": {
"type": "string",
"description": "The description of the debit memo item.\n"
},
"taxCodeName": {
"type": "string",
"description": "Name of the tax code identifies which tax rules and tax rates to apply to a specific debit memo item.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the debit memo item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo item was last updated.\n"
},
"chargeNumber": {
"type": "string",
"description": "The number of the charge associated with the debit memo item.\n"
},
"subscription": {
"$ref": "#/components/schemas/NestedSubscriptionOnExpand"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the invoice item associated with the debit memo item.\n"
},
"unitOfMeasure": {
"type": "string",
"description": "The units to measure usage.\n"
},
"journalEntryId": {
"type": "string",
"description": "The ID of the journal entry that corresponds to this debit memo item.\n"
},
"processingType": {
"enum": [
"Charge",
"Discount"
],
"type": "string",
"description": "The type of the charge for the debit memo item. \n"
},
"ratePlanCharge": {
"$ref": "#/components/schemas/NestedRatePlanChargeOnExpand"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The end date of the service period associated with this debit memo item. Service ends one second before the date specified in this field.\n"
},
"sourceItemType": {
"enum": [
"CreditMemoItem",
"SubscriptionComponent",
"InvoiceDetail",
"ProductRatePlanCharge"
],
"type": "string",
"description": "The type of the source item.\n"
},
"subscriptionId": {
"type": "string",
"description": "The ID of the subscription associated with the debit memo item.\n"
},
"appliedToItemId": {
"type": "string",
"description": "The parent debit memo item that this debit memo items is applied to if this item is discount.\n"
},
"taxExemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "The debit memo item amount excluding tax.\n"
},
"creditMemoItemId": {
"type": "string"
},
"ratePlanChargeId": {
"type": "string",
"description": "The ID of the rate plan charge associated with the debit memo item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The start date of the service period associated with this debit memo item. If the associated charge is a one-time fee, this date is the date of that charge.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "The number of the subscription associated with the debit memo item.\n"
},
"itemSoldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the debit memo item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"appliedToOthersAmount": {
"type": "number"
},
"beAppliedByOthersAmount": {
"type": "number"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot associated with the credit memo.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of the product rate plan charge based on which the debit memo item is created.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the credit memo.\n"
},
"itemSoldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the debit memo item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"deferredRevenueAccountingCodeId": {
"type": "string",
"description": "The Deferred Revenue accounting code for the credit memo item.\n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "The Account Receivable accounting code for the credit memo item.\n"
},
"recognizedRevenueAccountingCodeId": {
"type": "string",
"description": "The Recognized Revenue accounting code for the credit memo item.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the debit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
}
ExpandedInvoice
{
"type": "object",
"title": "QueryInvoiceResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the invoice.\n"
},
"amount": {
"type": "string",
"format": "number",
"description": "The total amount of the invoice.\n"
},
"source": {
"enum": [
"BillRun",
"API",
"ApiSubscribe",
"ApiAmend"
],
"type": "string",
"description": "The source of the invoice.\n"
},
"status": {
"enum": [
"Draft",
"Posted"
],
"type": "string",
"description": "The status of the invoice.\n"
},
"account": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"autoPay": {
"type": "boolean",
"description": "Whether invoices are automatically picked up for processing in the corresponding payment run.\n"
},
"balance": {
"type": "number",
"format": "double",
"description": "The remaining balance of the invoice after all payments, adjustments, and refunds are applied.\n"
},
"dueDate": {
"type": "string",
"format": "date",
"description": "The date by which the payment for this invoice is due, in `yyyy-mm-dd` format.\n"
},
"comments": {
"type": "string",
"description": "Comments about the invoice.\n"
},
"currency": {
"type": "string",
"nullable": true,
"description": "The currency of the invoice.\n\n**Note:** By default, the currency on a billing document matches the default currency set on the associated account. \nHowever, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. \nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currency</a>.\n"
},
"postedBy": {
"type": "string",
"description": "The user ID of the person who moved the invoice to Posted status.\n"
},
"reversed": {
"type": "boolean",
"description": "Whether the invoice is reversed.\n"
},
"sourceId": {
"type": "string",
"description": "The ID of the invoice source.\nIf an invoice is generated from a bill run, the value is the number of the corresponding bill run.Otherwise, the value is `null`.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the invoice.\n"
},
"taxAmount": {
"type": "string",
"format": "number",
"description": "The amount of taxation.\n"
},
"taxStatus": {
"enum": [
"Complete",
"Error",
"UnknownError",
"DuplicateDoc",
"InvalidRequest",
"InvalidResponse",
"TaxEngineError",
"ConcurrentModify",
"InternalServerError",
"TaxCodeTemplateError"
],
"type": "string",
"description": "The status that the tax engine return after it calculates the taxes of this invoice.\n"
},
"postedDate": {
"type": "string",
"format": "date",
"description": "The date when the invoice was posted.\n"
},
"sourceType": {
"enum": [
"Subscription",
"Standalone",
"Order",
"Consolidation"
],
"type": "string",
"description": "The type of the invoice source.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in this bill run.\n"
},
"taxMessage": {
"type": "string",
"description": "The message that the tax engine return if it calculates the taxes of this invoice fails.\n"
},
"templateId": {
"type": "string",
"description": "The ID of the invoice template.\n\n- If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled, the value of this field depends on the configuration of the invoice template. \n - If you specify an invoice template at the subscription level, the value of this field is automatically populated from the corresponding subscription.\n - If you do not specify any invoice template at the subscription level, the value of this field is automatically populated from the corresponding account.\n- If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the invoice.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the invoice gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"invoiceDate": {
"type": "string",
"format": "date",
"description": "The date that appears on the invoice being created.\n"
},
"paymentLink": {
"type": "string",
"description": "A link to the Payment Link page where the customer can pay the invoice.\n\nThe link is generated only if the invoice is posted after enabling the Payment Link feature on your tenant.\n\n**Note**: The Payment Link feature is in the Early Adopter phase. \nYou can enable the Payment Link feature through a self-service configuration in the **Manage Features** setting for Zuora Payments.\n"
},
"paymentTerm": {
"type": "string",
"example": "Net 30",
"description": "The payment term associated with the invoice. The payment term determines the due dates of\ninvoices.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the invoice.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The time that the invoice gets updated in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedInvoiceItemOnExpand"
}
},
"refundAmount": {
"type": "string",
"format": "number",
"description": "Specifies the amount of a refund that was applied against an earlier payment on the invoice.\n"
},
"billToContact": {
"$ref": "#/components/schemas/ExpandedContact"
},
"includesUsage": {
"type": "boolean",
"description": "Specifies whether the invoice includes usage charges.\n"
},
"invoiceNumber": {
"type": "string",
"description": "The unique identification number of the invoice.\n"
},
"paymentAmount": {
"type": "string",
"format": "number",
"description": "The amount of payments applied to the invoice.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the invoice.\n"
},
"eInvoiceFileId": {
"type": "string",
"description": "The ID of the e-invoice file.\n"
},
"eInvoiceStatus": {
"enum": [
"Processing",
"Generated",
"Success",
"Failed"
],
"type": "string",
"description": "It could be Processing, Generated, Success, Failed. If it’s Failed, it will have an error code and message. If it’s Generated or Success, both error code and message are empty, and eInvoiceFileId stores the file id of e-invoice.\n"
},
"organizationId": {
"type": "string",
"description": "ID of the organization this object belongs to.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the invoice.\n"
},
"includesOneTime": {
"type": "boolean",
"description": "Specifies whether the invoice includes one-time charges.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the invoice.\n"
},
"taxExemptAmount": {
"type": "string",
"format": "number",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"adjustmentAmount": {
"type": "string",
"format": "number",
"description": "The amount of the invoice adjustments associated with the invoice.\n"
},
"amountWithoutTax": {
"type": "string",
"format": "number",
"description": "The invoice amount excluding tax.\n"
},
"creditMemoAmount": {
"type": "string",
"format": "number",
"description": "The currency amount of all credit memos applied to this invoice.\n\n**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"eInvoiceErrorCode": {
"type": "string",
"description": "The error code when status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor.\n"
},
"includesRecurring": {
"type": "boolean",
"description": "Specifies whether the invoice includes recurring charges.\n"
},
"lastEmailSentDate": {
"type": "string",
"description": "The date when the invoice was last emailed.\n"
},
"eInvoiceErrorMessage": {
"type": "string",
"description": "The error message when status is \"Failed\". This message can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor.\n"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot associated with the invoice.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the invoice.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Error",
"Ignore",
"Yes",
"No"
],
"type": "string",
"description": "Whether the invoice was transferred to an external accounting system.\n"
},
"creditBalanceAdjustmentAmount": {
"type": "string",
"format": "number",
"description": "The currency amount of the adjustment applied to the customer's credit balance.\n\n **Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.\n"
}
}
}
ExpandedInvoiceItem
{
"type": "object",
"title": "QueryInvoiceItemResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the invoice item.\n"
},
"sKU": {
"type": "string",
"description": "The SKU of the product associated with the invoice item.\n"
},
"uOM": {
"type": "string",
"description": "The unit of measure (UOM) that is configured in **Settings > Billing** for the product rate plan charge.\n"
},
"balance": {
"type": "number",
"description": "The balance of the invoice item.\n\n**Note**: This field is only available if you have the Invoice Settlement feature enabled.\n"
},
"invoice": {
"$ref": "#/components/schemas/NestedInvoiceOnExpand"
},
"taxCode": {
"type": "string",
"description": "The tax code of the invoice item.\n**Note** Only when taxation feature is enabled, this field can be presented.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive"
],
"type": "string",
"description": "The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.\n"
},
"itemType": {
"type": "string",
"description": "The type of the invoice item.\n"
},
"quantity": {
"type": "number",
"description": "The quantity of this item, in the configured unit of measure for the\ncharge.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with the invoice item.\n"
},
"invoiceId": {
"type": "string",
"description": "The unique identifier of the invoice to which this invoice item belongs.\n"
},
"productId": {
"type": "string",
"description": "The ID of the product that the invoice item is created from.\n"
},
"taxAmount": {
"type": "string",
"format": "decimal",
"description": "The amount of tax applied to the charge.\n"
},
"unitPrice": {
"type": "number",
"format": "double",
"description": "The per-unit price of the invoice item."
},
"chargeDate": {
"type": "string",
"format": "date-time",
"description": "The date when the invoice item is charged, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"chargeName": {
"type": "string",
"description": "The name of the charge."
},
"ratePlanId": {
"type": "string",
"description": "The ID of the rate plan that the invoice is created from.\n"
},
"revRecCode": {
"type": "string",
"description": "The revenue recognition code.\n"
},
"amendmentId": {
"type": "string",
"description": "The ID of the amendment associated with the subscription. \n\n**Note**: This field is available only if you do not have Orders enabled for your tenant.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the invoice item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the invoice item was created.\n"
},
"description": {
"type": "string",
"description": "The description of the invoice item."
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the invoice item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the invoice item was last updated.\n"
},
"chargeAmount": {
"type": "string",
"format": "decimal",
"description": "The amount of the charge. \n\nThis amount does not include taxes regardless if the charge's tax mode is inclusive or exclusive.\n"
},
"chargeNumber": {
"type": "string",
"description": "Number of the charge.\n"
},
"subscription": {
"$ref": "#/components/schemas/NestedSubscriptionOnExpand"
},
"fulfillmentId": {
"type": "string",
"description": "The reference ID of the fulfillment associated with the invoice item.\n"
},
"orderLineItem": {
"$ref": "#/components/schemas/NestedOrderLineItemOnExpand"
},
"taxationItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedTaxationItem"
}
},
"accountingCode": {
"type": "string",
"description": "The accounting code associated with the invoice item."
},
"discountAmount": {
"type": "number",
"description": "The amount of the discount.\n"
},
"journalEntryId": {
"type": "string",
"description": "The ID of the journal entry that corresponds to this invoice item.\n"
},
"processingType": {
"enum": [
"Charge",
"Discount",
"Prepayment",
"Tax",
"Rounding"
],
"type": "string",
"description": "The kind of the charge for the invoice item. \n"
},
"ratePlanCharge": {
"$ref": "#/components/schemas/NestedRatePlanChargeOnExpand"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The end date of the service period for this item, i.e., the last day\nof the service period, as _yyyy-mm-dd_.\n"
},
"sourceItemType": {
"enum": [
"SubscriptionComponent",
"Rounding",
"ProductRatePlanCharge",
"None",
"OrderLineItem"
],
"type": "string",
"description": "The type of the source item.\n"
},
"subscriptionId": {
"type": "string",
"description": "ID of the subscription associated with the invoice item.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the invoice.\n"
},
"orderLineItemId": {
"type": "string",
"description": "The reference ID of the oder line item associated with the invoice item.\n"
},
"parentAccountId": {
"type": "string",
"description": "The parent account of the account associated with the invoice.\n\n**Note**: This field is available only if you have <a\nhref=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\"\ntarget=\"_blank\">Customer Hierarchy</a> enabled for your tenant.\n"
},
"revRecStartDate": {
"type": "string",
"format": "date"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the invoice.\n"
},
"taxExemptAmount": {
"type": "number"
},
"bookingReference": {
"type": "string",
"description": "The booking reference of the invoice item.\n"
},
"ratePlanChargeId": {
"type": "string",
"description": "The ID of the rate plan charge associated with the invoice item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The start date of the service period for this item, as _yyyy-mm-dd_.\nFor a one-time fee item, the date of the charge.\n"
},
"invoiceScheduleId": {
"type": "string",
"description": "The ID of the invoice schedule associated with the rate plan charge on the subscription.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"productRatePlanId": {
"type": "string",
"description": "The ID of the product rate plan that the invoice item is created from.\n"
},
"numberOfDeliveries": {
"type": "number",
"description": "The number of deliveries dedicated to the Delivery Pricing charges. \n**Note**: This field is available only if you have the Delivery Pricing feature enabled. \n"
},
"subscriptionNumber": {
"type": "string",
"description": "Number of the subscription associated with the invoice item.\n"
},
"itemSoldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the invoice item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "The purchase order number associated with the invoice item.\n"
},
"invoiceScheduleItemId": {
"type": "string",
"description": "The ID of the invoice schedule item that generates this invoice item.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"appliedToInvoiceItemId": {
"type": "string",
"description": "The unique ID of the invoice item that the discount charge is applied\nto.\n"
},
"commitmentChargeNumber": {
"type": "string"
},
"defaultPaymentMethodId": {
"type": "string",
"description": "The ID of the default payment method on the associated account.\n"
},
"revRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate"
],
"type": "string",
"description": "The date when revenue recognition is triggered.\n"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot associated with the invoice.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of the product rate plan charge that the invoice item is created from.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the invoice.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The revenue recognition rule of the invoice item.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"itemSoldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the invoice item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"commitmentChargeSegmentNumber": {
"type": "string"
},
"contractAssetAccountingCodeId": {
"type": "string",
"description": "ID of the accounting code for contract asset. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"deferredRevenueAccountingCodeId": {
"type": "string",
"description": "ID of the deferred revenue accounting code associated with the invoice item.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "ID of the account receivable accounting code associated with the invoice item.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"adjustmentRevenueAccountingCodeId": {
"type": "string",
"description": "The accounting code for adjustment revenue. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"contractLiabilityAccountingCodeId": {
"type": "string",
"description": "ID of the accounting code for contract liability. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"recognizedRevenueAccountingCodeId": {
"type": "string",
"description": "ID of the recognized revenue accounting code associated with the invoice item.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"adjustmentLiabilityAccountingCodeId": {
"type": "string",
"description": "ID of the accounting code for adjustment liability. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"unbilledReceivablesAccountingCodeId": {
"type": "string"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the invoice item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"contractRecognizedRevenueAccountingCodeId": {
"type": "string",
"description": "ID of the accounting code for contract recognized revenue. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
}
ExpandedOrderAction
{
"type": "object",
"title": "QueryOrderActionResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the order action.\n"
},
"type": {
"enum": [
"CreateSubscription",
"TermsAndConditions",
"AddProduct",
"UpdateProduct",
"RemoveProduct",
"RenewSubscription",
"CancelSubscription",
"OwnerTransfer",
"Suspend",
"Resume",
"ChangePlan"
],
"type": "string",
"description": "Type of the order action.\n\n**Note**: The change plan type of order action is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.\n"
},
"order": {
"$ref": "#/components/schemas/NestedOrderOnExpand"
},
"orderId": {
"type": "string",
"description": "The unique identifier of the order that the order action belongs to.\n"
},
"subType": {
"enum": [
"Upgrade",
"Downgrade",
"Crossgrade",
"PlanChanged"
],
"type": "string",
"description": "The sub type for the change plan order action.\n\nIf this field was not set by user, the field is automatically generated by the system according to the following rules:\n\nWhen the old and new rate plans are within the same Grading catalog group:\n* If the grade of new plan is greater than that of the old plan, this is an \"Upgrade\".\n* If the grade of new plan is less than that of the old plan, this is a \"Downgrade\".\n* If the grade of new plan equals that of the old plan, this is a \"Crossgrade\".\n\nWhen the old and new rate plans are not in the same Grading catalog group, or either has no group, this is \"PlanChanged\".\n"
},
"sequence": {
"type": "integer",
"format": "int32",
"description": "The sequence of the order actions processed in the order.\n"
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN"
],
"type": "string",
"description": "The type of the subscription term.\n"
},
"autoRenew": {
"type": "boolean",
"default": false,
"description": "If `true`, the subscription automatically renews at the end of the term. \n"
},
"resumeDate": {
"type": "string",
"format": "date",
"description": "The resume date when the resumption takes effect.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the order action.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the order action gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"currentTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the current subscription term.\n"
},
"paymentTerm": {
"type": "string",
"description": "The name of the payment term associated with the subscription. For\nexample, `Net 30`. The payment term determines the due dates of invoices.\n\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"renewalTerm": {
"type": "integer",
"format": "int64",
"default": 0,
"description": "The length of the period for the subscription renewal term. \n"
},
"suspendDate": {
"type": "string",
"format": "date",
"description": "The date when subscription suspension takes effect, in the `yyyy-mm-dd` format.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the order action.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the order action was last updated.\n"
},
"renewSetting": {
"enum": [
"RENEW_WITH_SPECIFIC_TERM",
"RENEW_TO_EVERGREEN"
],
"type": "string",
"default": "RENEW_WITH_SPECIFIC_TERM",
"description": "Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed.\n"
},
"subscription": {
"$ref": "#/components/schemas/NestedSubscriptionOnExpand"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the subscription.\n \n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"termStartDate": {
"type": "string",
"format": "date",
"description": "The date on which the subscription term begins, as `yyyy-mm-dd`. If this is a renewal subscription, this date is different from the subscription start date.\n"
},
"subscriptionId": {
"type": "string",
"description": "The unique identifier of the subscription associated with the order action.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"effectivePolicy": {
"enum": [
"EffectiveImmediately",
"EffectiveEndOfBillingPeriod",
"SpecificDate"
],
"type": "string",
"description": "The default value for the `effectivePolicy` field is as follows:\n * If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default.\n * If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default.\n * Otherwise, the effective policy is `SpecificDate` by default.\n\n**Notes**: \n * When setting this field to `EffectiveEndOfBillingPeriod`, you cannot set the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/W_Subscription_and_Amendment_Dates#Billing_Trigger_Dates\" target=\"_blank\">billing trigger dates</a> for the subscription as the system will automatically set the trigger dates to the end of billing period.\n * When setting this field to `SpecificDate`, you must also set the `contractEffectiveDate` field.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"cancellationPolicy": {
"enum": [
"EndOfCurrentTerm",
"EndOfLastInvoicePeriod",
"SpecificDate"
],
"type": "string",
"description": "Cancellation method. \n"
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "Effective contract date for this subscription, as yyyy-mm-dd.\n"
},
"currentTermPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"default": "Month",
"description": "The period type for the current subscription term.\n"
},
"renewalTermPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"default": "Month",
"description": "The period type for the subscription renewal term.\n\nThis field is used with the `renewalTerm` field to specify the subscription renewal term.\n"
},
"serviceActivationDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd.\n"
},
"customerAcceptanceDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.\n"
},
"cancellationEffectiveDate": {
"type": "string",
"format": "date",
"description": "Date when the cancellation takes effect, in the `yyyy-mm-dd` format. Used only if `cancellationPolicy` is `SpecificDate`. It should not be earlier than the subscription contract-effective date, later than the subscription term-end date, or within a period for which the customer has been invoiced.\n"
},
"clearingExistingPaymentTerm": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingSequenceSet": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingBillToContact": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingSoldToContact": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"subscriptionVersionAmendmentId": {
"type": "string",
"description": "The unique identifier of the amendment that changes the version of the subscription.\n"
},
"clearingExistingInvoiceTemplate": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
}
}
}
ExpandedOrderLineItem
{
"type": "object",
"title": "QueryOrderLineItemResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the order line item.\n"
},
"uOM": {
"type": "string",
"description": "Specifies the units to measure usage.\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"amount": {
"type": "number",
"description": "The total amount for the Order Line Item (OLI).\n"
},
"soldTo": {
"type": "string",
"description": "The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the sold-to contact of an order line item.\n"
},
"orderId": {
"type": "string",
"description": "The ID of the order that the order line item belongs to.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"taxMode": {
"enum": [
"TaxInclusive",
"TaxExclusive"
],
"type": "string",
"description": "The tax mode for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"billToId": {
"type": "string",
"description": "The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the bill-to contact of an order line item.\n"
},
"discount": {
"type": "number",
"description": "This field shows the total discount amount that is applied to an order line item after the `inlineDiscountType`, `inlineDiscountPerUnit` and `quantity` fields are set.\n\nThe inline discount is applied to the list price of an order line item.\n"
},
"itemName": {
"type": "string",
"description": "The name of the Order Line Item (OLI).\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"itemType": {
"enum": [
"Product",
"Fee",
"Services"
],
"type": "string",
"description": "The type of the Order Line Item (OLI). \n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"quantity": {
"type": "number",
"description": "The quantity of units, such as the number of authors in a hosted wiki service.\n\nYou can update this field for a sales or return OLI only when the OLI in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"itemState": {
"enum": [
"Executing",
"Booked",
"SentToBilling",
"Complete",
"Cancelled"
],
"type": "string",
"description": "The state of the Order Line Item (OLI). See [State transitions for an order, order line item, and fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States) for more information.\n\nTo generate invoice for an OLI, you must set this field to `SentToBilling` and set the `billTargetDate` field .\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` or 'Booked' or `SentToBilling`state (when the `itemState` field is set as `Executing` or `SentToBilling`).\n"
},
"listPrice": {
"type": "number",
"description": "The extended list price for an order line item, calculated by the formula:\nlistPrice = listPricePerUnit * quantity\n"
},
"itemNumber": {
"type": "string",
"description": "The number for the Order Line Item (OLI).\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"billingRule": {
"enum": [
"TriggerWithoutFulfillment",
"TriggerAsFulfillmentOccurs"
],
"type": "string",
"description": "The billing rule of the Order Line Item.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the order line item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the order line item gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"description": {
"type": "string",
"description": "The description of the Order Line Item.\n"
},
"productCode": {
"type": "string",
"description": "The product code for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the order line item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the order line item was last updated.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedInvoiceItemOnExpand"
}
},
"itemCategory": {
"enum": [
"Sales",
"Return"
],
"type": "string",
"default": "Sales",
"description": "The category of the Order Line Item, to indicate a product sale or return.\n"
},
"amountPerUnit": {
"type": "number",
"description": "The actual charged amount per unit for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"accountingCode": {
"type": "string",
"description": "The accountingCode for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"billTargetDate": {
"type": "string",
"format": "date",
"description": "The target date for the Order Line Item (OLI) to be picked up by bill run for generating billing documents.\n\nTo generate billing documents for an OLI, you must set this field and set the `itemState` field to `SentToBilling`.\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"ownerAccountId": {
"type": "string",
"description": "The account ID of the owner of the order line item.\n"
},
"originalOrderId": {
"type": "string",
"description": "The ID of the original sale order for a return order line item. \n"
},
"transactionDate": {
"type": "string",
"format": "date",
"description": "The date when the transaction occurs.\n"
},
"amendedByOrderOn": {
"type": "string",
"format": "date",
"description": "The date of the amended order for a return order line item.\n"
},
"amountWithoutTax": {
"type": "number",
"description": "The total amount for the Order Line Item (OLI) excluding tax.\n"
},
"billToSnapshotId": {
"type": "string",
"description": "The snapshot of the ID for an account used as the bill-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `billToSnapshotId` field is exposed while retrieving the order line item details.\n"
},
"listPricePerUnit": {
"type": "number",
"description": "The list price per unit for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"soldToSnapshotId": {
"type": "string",
"description": "The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `soldToSnapshotId` field is exposed while retrieving the order line item details.\n"
},
"originalOrderDate": {
"type": "string",
"format": "date",
"description": "The date of the original sale order for a return order line item.\n"
},
"quantityFulfilled": {
"type": "number",
"description": "The fulfilled quantity for an order line item.\n"
},
"inlineDiscountType": {
"enum": [
"Percentage",
"FixedAmount",
"None"
],
"type": "string",
"description": "This field is used to specify the inline discount type, which can be `Percentage`, `FixedAmount`, or `None`. The default value is `Percentage`.\n\nThis field is used together with the `inlineDiscountPerUnit` field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item. \n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"
},
"transactionEndDate": {
"type": "string",
"format": "date",
"description": "The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the `transactionStartDate` field.\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"originalOrderNumber": {
"type": "string",
"description": "The number of the original sale order for a return order line item. \n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "Used by customers to specify the Purchase Order Number provided by the buyer.\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"requiresFulfillment": {
"type": "boolean",
"description": "The flag to show whether fulfillment is needed or not. It's derived from billing rule of the Order Line Item.\n"
},
"soldToOrderContactId": {
"type": "string",
"description": "The ID of the sold-to contact for the order.\n"
},
"transactionStartDate": {
"type": "string",
"format": "date",
"description": "The date a transaction starts. The default value of this field is the order date.\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"inlineDiscountPerUnit": {
"type": "number",
"description": "This field is used in accordance with the `inlineDiscountType` field, in the following manner:\n* If the `inlineDiscountType` field is set as `Percentage`, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify `5` in this field, the discount percentage is 5%.\n* If the `inlineDiscountType` field is set as `FixedAmount`, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify `10` in this field, the discount amount on each unit of the order line item is 10.\n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"
},
"invoiceOwnerAccountId": {
"type": "string",
"description": "The account ID of the invoice owner of the order line item.\n"
},
"revenueRecognitionRule": {
"type": "string",
"description": "The Revenue Recognition rule for the Order Line Item.\n"
},
"originalOrderLineItemId": {
"type": "string",
"description": "The ID of the original sale order line item for a return order line item. \n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "ID of a Product Rate Plan Charge. Only one-time charges are supported.\n"
},
"relatedSubscriptionNumber": {
"type": "string",
"description": "This field is used to relate an order line item to an subscription. \n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"quantityAvailableForReturn": {
"type": "number",
"description": "The quantity that can be returned for an order line item. \n"
},
"quantityPendingFulfillment": {
"type": "number",
"description": "The quantity to fulfill for an order line item. \n"
},
"contractAssetAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"originalOrderLineItemNumber": {
"type": "string",
"description": "The number of the original sale order line item for a return order line item. \n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"deferredRevenueAccountingCodeId": {
"type": "string",
"description": "The deferred revenue accounting code for the Order Line Item.\n"
},
"adjustmentRevenueAccountingCodeId": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"recognizedRevenueAccountingCodeId": {
"type": "string",
"description": "The recognized revenue accounting code for the Order Line Item.\n"
},
"adjustmentLiabilityAccountingCodeId": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"unbilledReceivablesAccountingCodeId": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related rate plan charges and order line items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.\n"
},
"contractRecognizedRevenueAccountingCodeId": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
}
}
}
ExpandedOrders
{
"type": "object",
"title": "QueryOrdersResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the order.\n"
},
"state": {
"type": "string",
"description": "The state of the bill-to address. The value is a valid state\n or province name or 2-character abbreviation.\n"
},
"status": {
"enum": [
"Draft",
"Pending",
"Completed",
"Cancelled",
"Scheduled",
"Executing",
"Failed"
],
"type": "string",
"description": "The status of the order. If the order contains any `Pending\nActivation` or `Pending Acceptance` subscription, the order status\nwill be `Pending`; If the order is in draft status, the order status\nwill be `Draft`; otherwise the order status is `Completed`.\n\n\nThe available order statuses are as follow:\n\n- `Draft`: The order is in draft status.\n\n- `Pending`: The order is in pending status.\n\n- `Completed`: The order is in completed status.\n\n- `Cancelled`: The draft or scheduled order is cancelled.\n\n- `Scheduled`: The order is in scheduled status and it is only valid\nif the Scheduled Orders feature is enabled.\n\n- `Executing`: The scheduled order is executed by a scheduler and it\nis only valid if the Scheduled Orders feature is enabled.\n\n- `Failed`: The scheduled order has failed.\n\n\n**Note**: To manage and access the <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/AA_Overview_of_Orders/P_Scheduled_Orders\"\ntarget=\"_blank\">Scheduled Orders</a> feature from the self-service\ninterface, see <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself\"\ntarget=\"_blank\">Enable billing features by yourself</a>.\n"
},
"account": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"category": {
"type": "string"
},
"response": {
"type": "string"
},
"accountId": {
"type": "string",
"description": "The unique identifier of the customer account associated with the\norder.\n"
},
"errorCode": {
"type": "string",
"description": "The error code of the error response.\n"
},
"orderDate": {
"type": "string",
"format": "date",
"description": "The date when the order is signed. All the order actions under this\norder will use this order date as the contract effective date if no\nadditinal contractEffectiveDate is provided.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the order.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the order gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"description": {
"type": "string",
"description": "The description of the order.\n"
},
"orderNumber": {
"type": "string",
"description": "The unique identifier of the order.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the order.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the order was last updated.\n"
},
"errorMessage": {
"type": "string",
"description": "The error message of the error response.\n"
},
"orderActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedOrderActionOnExpand"
}
},
"scheduledDate": {
"type": "string",
"format": "date",
"description": "The date for the order scheduled.\n"
},
"orderLineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedOrderLineItemOnExpand"
}
},
"invoiceScheduleId": {
"type": "string",
"description": "The unique identifier of the invoice schedule associated with the\norder.\n"
},
"createdByMigration": {
"type": "boolean",
"description": "Indicates whether the order is created by migration.\n"
},
"scheduledDatePolicy": {
"enum": [
"SpecificDate"
],
"type": "string",
"description": "Date policy of the scheduled order."
}
}
}
ExpandedPayment
{
"type": "object",
"title": "QueryPaymentResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the payment.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the payment.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment.\n"
},
"source": {
"enum": [
"PaymentRun",
"Import",
"Manually",
"API"
],
"type": "string",
"description": "Indicates how the payment was created, whether through API, manually, import, or payment run.\n"
},
"status": {
"enum": [
"Draft",
"Processing",
"Processed",
"Error",
"Canceled",
"Posted"
],
"type": "string",
"description": "The status of the payment.\n"
},
"account": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"comment": {
"type": "string",
"description": "Comments about the payment.\n"
},
"gateway": {
"type": "string",
"description": "Name of the gateway instance that processes the payment. \n"
},
"currency": {
"type": "string",
"example": "USD",
"description": "When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI.\n\nWhen Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.\n"
},
"payoutId": {
"type": "string",
"description": "The payout ID of the payment from the gateway side.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account that the payment is for.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways.\n"
},
"prepayment": {
"type": "boolean",
"description": "Indicates whether the payment is used as a reserved payment. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.\n"
},
"sourceName": {
"type": "string",
"description": "Name of the source. It can be a payment run number or a file name.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date when the payment was canceled.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the payment.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was submitted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the payment.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment gets updated in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"gatewayState": {
"enum": [
"MarkedForSubmission",
"Submitted",
"Settled",
"NotSubmitted",
"FailedToSettle"
],
"type": "string",
"description": "The status of the payment in the gateway; use for reconciliation. \n"
},
"isStandalone": {
"type": "boolean",
"description": "Indicates whether the payment is a standalone payment. A standalone\npayment is a payment that is not associated with any invoice or\nsubscription.\n"
},
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the payment that is refunded.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the payment.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date and time when the payment takes effect, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethod": {
"$ref": "#/components/schemas/NestedPaymentMethodOnExpand"
},
"paymentNumber": {
"type": "string",
"example": "P-00000028.",
"description": "The unique identification number of a payment. \n"
},
"accountingCode": {
"type": "string",
"description": "The accounting code for the charge. Accounting codes group\ntransactions that contain similar accounting attributes.\n"
},
"gatewayOrderId": {
"type": "string",
"description": "A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created.\n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the payment. This message is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the payment.\n"
},
"paymentOptionId": {
"type": "string",
"description": "ID of the paymentOption object, which describe the transactional level rules for processing payments. \n"
},
"unappliedAmount": {
"type": "number",
"description": "The unapplied amount of the payment.\n"
},
"authTransactionId": {
"type": "string",
"description": "The authorization transaction ID from the payment gateway.\n"
},
"lastEmailDateTime": {
"type": "string",
"description": "The date and time when the last email was sent to the customer for the payment.\n"
},
"transactionSource": {
"enum": [
"C_Unscheduled",
"M_Recurring",
"M_Unscheduled",
"M_MOTO"
],
"type": "string",
"description": "Payment transaction source used to differentiate the transaction source in Stored Credential Transaction framework.\n - `C_Unscheduled`: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates.\n - `M_Recurring`: Merchant-initiated transaction (MIT) that occurs at regular intervals.\n - `M_Unscheduled`: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates.\n - `M_MOTO`: Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See [Overview of Stripe payment gateway integration](https://knowledgecenter.zuora.com/Zuora_Collect/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration) for more information.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the payment. This code is gateway-dependent.\n"
},
"paymentApplications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedPaymentApplication"
}
},
"referencedPaymentID": {
"type": "string",
"description": "The ID of a referenced payment. \n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a charge was marked and waiting for batch\nsubmission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"gatewayTransactionState": {
"type": "string"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankIdentificationNumber": {
"type": "string",
"description": "The first six or eight digits of the credit card or debit card used for the payment, when applicable. \nUse this field to <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DF_Reconciling_Payments_with_Merchant_Accounts\" target=\"_blank\">reconcile payments between the gateway and merchant banks</a>.\n"
},
"secondPaymentReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"appliedCreditBalanceAmount": {
"type": "number",
"description": "The amount of the payment to apply to a credit balance. \n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
}
ExpandedPaymentApplication
{
"type": "object",
"title": "QueryPaymentApplicationResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the payment application.\n"
},
"payment": {
"$ref": "#/components/schemas/NestedPaymentOnExpand"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the payment application.\n"
},
"invoiceId": {
"type": "string",
"description": "The ID of the invoice to which the payment is applied.\n"
},
"paymentId": {
"type": "string",
"example": "4028905f5a87c0ff015a87eb6b75007f",
"description": "The unique ID of the created payment. \n"
},
"applyAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the payment.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the payment application.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment application was created.\n"
},
"debitMemoId": {
"type": "string",
"description": "The ID of the debit memo to which the payment is applied.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the payment application.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment application was last updated.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the payment application takes effect, in `yyyy-mm-dd` format. \nThe effective date is later than or equal to the maximum effective date of the payment.\n"
},
"journalEntryId": {
"type": "string",
"description": "The ID of the journal entry that corresponds to this transaction.\n"
},
"applicationGroupId": {
"type": "string",
"description": "The ID of the application group to which this payment application belongs.\n"
},
"cashAccountingCodeId": {
"type": "string",
"description": "The accounting code for cash payments.\n"
},
"billingDocumentOwnerId": {
"type": "string",
"description": "The ID of the billing document owner. \n"
},
"paymentApplicationStatus": {
"enum": [
"Processing",
"Processed",
"Cancelled"
],
"type": "string",
"description": "The status of the payment application.\n"
},
"unappliedPaymentAccountingCodeId": {
"type": "string",
"description": "The accounting code for the unapplied payment.\n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "The accountReceivableAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a>, <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a>, and <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Get_started_with_Invoice_Settlement/AA_Overview_of_Invoice_Settlement\" target=\"_blank\">Invoice Settlement</a> features are enabled.\n"
}
}
}
ExpandedPaymentMethod
{
"type": "object",
"title": "QueryPaymentMethodResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the payment method.\n"
},
"city": {
"type": "string",
"description": "The city of the customer's address. Applicable to debit payment methods.\n"
},
"iBAN": {
"type": "string",
"description": "The International Bank Account Number used to create the SEPA payment method. The value is masked.\n"
},
"name": {
"type": "string",
"description": "The name of the payment method.\n"
},
"type": {
"type": "string",
"description": "The type of the payment method. For example, `CreditCard`.\n"
},
"email": {
"type": "string",
"description": "The email address of the payment method holder.\n"
},
"phone": {
"type": "string",
"description": "The phone number that the account holder registered with the bank. This\nfield is used for credit card validation when passing to a gateway.\n"
},
"state": {
"type": "string",
"description": "The state of the customer's address. Only applicable to direct debit\npayment methods.\n"
},
"active": {
"type": "boolean",
"description": "Indicates whether the payment method is active.\n"
},
"account": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"achCity": {
"type": "string",
"maxLength": 40,
"description": "City for the ACH payment method.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"country": {
"type": "string",
"description": "The two-letter country code of the customer's address. Applicable to direct debit payment methods."
},
"subType": {
"type": "string",
"description": "The identification reference indicating the subtype of the custom payment method.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.\n"
},
"tokenId": {
"type": "string",
"description": "A gateway unique identifier that replaces sensitive payment method data or\nrepresents a gateway's unique customer profile. Applicable to CC Reference\nTransaction payment methods.\n"
},
"achState": {
"type": "string",
"description": "State for the ACH payment method. Must be a valid state name or 2-character abbreviation.\n\nSee [United States Standard State Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/B_State_Names_and_2-Digit_Codes) and [Canadian Standard Province Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/C_Canadian_Province_Names_and_2-Digit_Codes) for the list of supported names and abbreviations.\n"
},
"bankCity": {
"type": "string",
"description": "The city of the direct debit bank."
},
"bankCode": {
"type": "string",
"description": "The sort code or number that identifies the bank. This is also known as the sort code. \n"
},
"bankName": {
"type": "string",
"description": "The name of the direct debit bank."
},
"isSystem": {
"type": "boolean",
"description": "Indicates whether the payment method is a system-generated payment method.\n"
},
"lastName": {
"type": "string",
"description": "The customer's last name. Only applicable to direct debit payment methods.\n"
},
"accountId": {
"type": "string",
"description": "The unique identifier of the account that the payment method is\nassociated with.\n"
},
"firstName": {
"type": "string",
"description": "The customer's first name. Only applicable to direct debit payment methods.\n"
},
"iPAddress": {
"type": "string",
"description": "The IP address of the user when the payment method was created or updated.\n"
},
"isCompany": {
"type": "boolean",
"description": "Whether the customer account is a company.\n"
},
"mandateId": {
"type": "string",
"description": "The mandate ID.\n"
},
"achAbaCode": {
"type": "string",
"description": "The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`.\n"
},
"achCountry": {
"type": "string",
"description": "Country for the ACH payment method. Must be a valid country name or abbreviation.\n\nSee <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions\" target=\"_blank\">View countries or regions</a> for the list of supported country names and abbreviations.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"paypalBaid": {
"type": "string",
"example": "I-1TJ3GAGG82Y9",
"description": "ID of a PayPal billing agreement. \n"
},
"paypalType": {
"type": "string",
"description": "The type of the PayPal payment method.\n"
},
"postalCode": {
"type": "string",
"description": "The zip code of the customer's address. Only applicable to direct debit\npayment methods.\n"
},
"streetName": {
"type": "string",
"description": "The street name of the customer's address. Only applicable to direct debit\npayment methods.\n"
},
"achAddress1": {
"type": "string",
"maxLength": 255,
"description": "First address line for the ACH payment method.\n"
},
"achAddress2": {
"type": "string",
"maxLength": 255,
"description": "Second address line for the ACH payment method.\n"
},
"achBankName": {
"type": "string",
"maxLength": 70,
"description": "The name of the bank where the ACH payment account is held.\n\nWhen creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value.\n"
},
"companyName": {
"type": "string",
"description": "The name of the company.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the payment method.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment method gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"paypalEmail": {
"type": "string",
"description": "Email address associated with the PayPal payment method. \n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the payment method.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment method gets updated in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"streetNumber": {
"type": "string",
"description": "The street number of the customer's address. Only applicable to direct\ndebit payment methods.\n"
},
"achPostalCode": {
"type": "string",
"maxLength": 20,
"description": "Zip code or postal code for the ACH payment method.\n"
},
"mandateReason": {
"type": "string",
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"description": "The status of the mandate from the gateway side.\n"
},
"secondTokenId": {
"type": "string",
"description": "A gateway unique identifier that replaces sensitive payment method data.\n\n**Note:** This field is only returned for the Credit Card Reference Transaction payment type.\n"
},
"achAccountName": {
"type": "string",
"description": "The name of the account holder, which can be either a person or a company. This field is only required if the `type` field is set to `ACH`.\n"
},
"achAccountType": {
"enum": [
"BusinessChecking",
"Checking",
"Saving"
],
"type": "string",
"description": "The type of bank account associated with the ACH payment method. This field is only required if the `type` field is set to `ACH`.\n\nWhen creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, `Checking` preferably.\n"
},
"bankBranchCode": {
"type": "string",
"description": "The branch code of the bank used for Direct Debit. \n"
},
"bankCheckDigit": {
"type": "string",
"description": "The check digit in the international bank account number, which confirms the validity of the account. Applicable to direct debit payment methods."
},
"bankPostalCode": {
"type": "string",
"description": "The zip code or postal code of the direct debit bank."
},
"bankStreetName": {
"type": "string",
"description": "The name of the street of the direct debit bank."
},
"creditCardCity": {
"type": "string",
"description": "The city of the card holder's address. Applicable to credit card and\ndirect debit payment methods.\n"
},
"creditCardType": {
"type": "string",
"description": "The type of the credit card or debit card.\n\nPossible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).\n\n**Note:** This field is only returned for the Credit Card and Debit Card payment types.\n"
},
"identityNumber": {
"type": "string",
"description": "The identity number of the account holder or the cardholder.\n"
},
"creditCardState": {
"type": "string",
"description": "The state where the credit card holder stays.\n"
},
"deviceSessionId": {
"type": "string",
"description": "The session ID of the user when the `PaymentMethod` was created or updated.\n"
},
"existingMandate": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Indicates whether the mandate is an existing mandate.\n"
},
"mandateReceived": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Indicates whether the mandate is received from the gateway.\n"
},
"userReferenceId": {
"type": "string",
"description": "The identification reference of the user or customer account.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.\n"
},
"bankStreetNumber": {
"type": "string",
"description": "The number of the direct debit bank."
},
"bankTransferType": {
"enum": [
"AutomatischIncasso",
"LastschriftDE",
"LastschriftAT",
"DemandeDePrelevement",
"DirectDebitUK",
"Domicil",
"LastschriftCH",
"RID",
"OrdenDeDomiciliacion",
"Autogiro",
"Betalingsservice"
],
"type": "string",
"description": "Specifies the type of direct debit transfer. The value of this field is dependent on the country of the user.\n\nPossible Values: \n\n\n* `AutomatischIncasso` (NL)\n\n* `LastschriftDE` (Germany)\n\n* `LastschriftAT` (Austria)\n\n* `DemandeDePrelevement` (FR)\n\n* `DirectDebitUK` (UK)\n\n* `Domicil` (Belgium)\n\n* `LastschriftCH` (CH)\n\n* `RID` (Italy)\n\n* `OrdenDeDomiciliacion` (Spain)\n* `Autogiro` (Sweden)\n* `Betalingsservice` (Denmark)\n"
},
"creditCardCountry": {
"type": "string",
"description": "The country where the credit card holder stays.\n\nWhen creating a payment method through a translated UI or Payment Page, a country name in a translated language might be selected. \nRegardless of the country texts selected when creating the payment method, only the supported country name returns in this field. \nFor a complete list of supported country names, see <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions\" target=\"_blank\">View countries or regions</a>. \nInternationalization is not supported for the API field value.\n"
},
"mandateUpdateDate": {
"type": "string",
"format": "date",
"description": "The date on which the mandate was updated.\n"
},
"methodReferenceId": {
"type": "string",
"description": "The identification reference of the custom payment method.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query.\n"
},
"creditCardAddress1": {
"type": "string",
"description": "The first line of the card holder's address, which is often a street\naddress or business name. Applicable to credit card and direct debit\npayment methods.\n"
},
"creditCardAddress2": {
"type": "string",
"description": "The second line of the card holder's address. Applicable to credit card\nand direct debit payment methods.\n"
},
"methodSpecificData": {
"type": "string",
"description": "Other method-specific data of the payment method.\n"
},
"paymentRetryWindow": {
"type": "integer",
"format": "int32",
"description": "The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours.\n"
},
"mandateCreationDate": {
"type": "string",
"format": "date",
"description": "The date on which the mandate was created.\n"
},
"paymentMethodStatus": {
"enum": [
"Active",
"Closed",
"Scrubbed"
],
"type": "string",
"description": "The status of the payment method.\n"
},
"useDefaultRetryRule": {
"type": "boolean",
"description": "Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings.\n"
},
"achAccountNumberMask": {
"type": "string",
"description": "The masked bank account number associated with the ACH payment method. This field is only required if the `type` field is set to `ACH`.\n"
},
"creditCardHolderName": {
"type": "string",
"description": "The full name of the credit card holder.\n"
},
"creditCardMaskNumber": {
"type": "string",
"description": "The masked credit card number, such as `*********1112`.\n"
},
"creditCardPostalCode": {
"type": "string",
"description": "The postal code for the address of the credit card holder.\n"
},
"paypalPreapprovalKey": {
"type": "string",
"description": "The PayPal preapproval key.\n"
},
"lastTransactionStatus": {
"type": "string",
"description": "The status of the most recent transaction."
},
"numConsecutiveFailures": {
"type": "integer",
"format": "int32",
"description": "The number of consecutive failed payments for this payment method. It is reset to `0` upon successful payment. \n"
},
"bankTransferAccountName": {
"type": "string",
"description": "The name on the direct debit bank account."
},
"bankTransferAccountType": {
"type": "string",
"description": "The type of the customer's bank account. Applicable to direct debit\npayment methods.\n"
},
"lastTransactionDateTime": {
"type": "string",
"format": "date-time",
"description": "The date and time of the most recent transaction.\n"
},
"bankIdentificationNumber": {
"type": "string",
"description": "The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method."
},
"creditCardExpirationYear": {
"type": "integer",
"format": "int32",
"description": "Four-digit expiration year.\n"
},
"creditCardExpirationMonth": {
"type": "integer",
"format": "int32",
"maximum": 12,
"minimum": 1,
"description": "One or two digits expiration month.\n"
},
"businessIdentificationCode": {
"type": "string",
"description": "The business identification code for Swiss direct payment methods that use\nthe Global Collect payment gateway. Only applicable to direct debit\npayment methods in Switzerland with Global Collect.\n"
},
"totalNumberOfErrorPayments": {
"type": "integer",
"format": "int32",
"description": "The number of error payments that used this payment method."
},
"bankTransferAccountNumberMask": {
"type": "string",
"description": "This is a masked displayable version of the bank account number, used for\nsecurity purposes. For example: `XXXXXXXXX54321`.\n"
},
"lastFailedSaleTransactionDate": {
"type": "string",
"format": "date",
"description": "The date of the last failed attempt to collect payment with this payment\nmethod.\n"
},
"maxConsecutivePaymentFailures": {
"type": "integer",
"format": "int32",
"description": "The number of allowable consecutive failures Zuora attempts with the payment method before stopping.\n"
},
"totalNumberOfProcessedPayments": {
"type": "integer",
"format": "int32",
"description": "The number of successful payments that used this payment method."
}
}
}
ExpandedPaymentMethodSnapshot
{
"type": "object",
"title": "QueryPaymentMethodSnapshotResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the payment method snapshot.\n"
},
"city": {
"type": "string",
"description": "The city of the customer's address. Applicable to debit payment methods.\n"
},
"iBAN": {
"type": "string",
"description": "The International Bank Account Number used to create the SEPA payment method. The value is masked.\n"
},
"name": {
"type": "string",
"description": "The name of the payment method.\n"
},
"type": {
"type": "string",
"description": "The type of the payment method. For example, `CreditCard`.\n"
},
"email": {
"type": "string",
"description": "The email address of the payment method holder.\n"
},
"phone": {
"type": "string",
"description": "The phone number that the account holder registered with the bank. This\nfield is used for credit card validation when passing to a gateway.\n"
},
"state": {
"type": "string",
"description": "The state of the customer's address. Only applicable to direct debit\npayment methods.\n"
},
"active": {
"type": "boolean",
"description": "Indicates whether the payment method is active.\n"
},
"achCity": {
"type": "string",
"maxLength": 40,
"description": "City for the ACH payment method.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"country": {
"type": "string",
"description": "The two-letter country code of the customer's address. Applicable to direct debit payment methods."
},
"subType": {
"type": "string",
"description": "The identification reference indicating the subtype of the custom payment method.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.\n"
},
"tokenId": {
"type": "string",
"description": "A gateway unique identifier that replaces sensitive payment method data or\nrepresents a gateway's unique customer profile. Applicable to CC Reference\nTransaction payment methods.\n"
},
"achState": {
"type": "string",
"description": "State for the ACH payment method. Must be a valid state name or 2-character abbreviation.\n\nSee [United States Standard State Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/B_State_Names_and_2-Digit_Codes) and [Canadian Standard Province Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/C_Canadian_Province_Names_and_2-Digit_Codes) for the list of supported names and abbreviations.\n"
},
"bankCity": {
"type": "string",
"description": "The city of the direct debit bank."
},
"bankCode": {
"type": "string",
"description": "The sort code or number that identifies the bank. This is also known as the sort code. \n"
},
"bankName": {
"type": "string",
"description": "The name of the direct debit bank."
},
"isSystem": {
"type": "boolean",
"description": "Indicates whether the payment method is a system-generated payment method.\n"
},
"lastName": {
"type": "string",
"description": "The customer's last name. Only applicable to direct debit payment methods.\n"
},
"accountId": {
"type": "string",
"description": "The unique identifier of the account that the payment method snapshot is\nassociated with.\n"
},
"firstName": {
"type": "string",
"description": "The customer's first name. Only applicable to direct debit payment methods.\n"
},
"iPAddress": {
"type": "string",
"description": "The IP address of the user when the payment method was created or updated.\n"
},
"isCompany": {
"type": "boolean",
"description": "Whether the customer account is a company.\n"
},
"mandateId": {
"type": "string",
"description": "The mandate ID.\n"
},
"achAbaCode": {
"type": "string",
"description": "The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`.\n"
},
"achCountry": {
"type": "string",
"description": "Country for the ACH payment method. Must be a valid country name or abbreviation.\n\nSee <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions\" target=\"_blank\">View countries or regions</a> for the list of supported country names and abbreviations.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"paypalBaid": {
"type": "string",
"example": "I-1TJ3GAGG82Y9",
"description": "ID of a PayPal billing agreement. \n"
},
"paypalType": {
"type": "string",
"description": "The type of the PayPal payment method.\n"
},
"postalCode": {
"type": "string",
"description": "The zip code of the customer's address. Only applicable to direct debit\npayment methods.\n"
},
"streetName": {
"type": "string",
"description": "The street name of the customer's address. Only applicable to direct debit\npayment methods.\n"
},
"achAddress1": {
"type": "string",
"maxLength": 255,
"description": "First address line for the ACH payment method.\n"
},
"achAddress2": {
"type": "string",
"maxLength": 255,
"description": "Second address line for the ACH payment method.\n"
},
"achBankName": {
"type": "string",
"maxLength": 70,
"description": "The name of the bank where the ACH payment account is held.\n\nWhen creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value.\n"
},
"companyName": {
"type": "string",
"description": "The name of the company.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the payment method snapshot.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment method snapshot gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"paypalEmail": {
"type": "string",
"description": "Email address associated with the PayPal payment method. \n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the payment method snapshot.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment method snapshot gets updated in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"streetNumber": {
"type": "string",
"description": "The street number of the customer's address. Only applicable to direct\ndebit payment methods.\n"
},
"achPostalCode": {
"type": "string",
"maxLength": 20,
"description": "Zip code or postal code for the ACH payment method.\n"
},
"mandateReason": {
"type": "string",
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"description": "The status of the mandate from the gateway side.\n"
},
"secondTokenId": {
"type": "string",
"description": "A gateway unique identifier that replaces sensitive payment method data.\n\n**Note:** This field is only returned for the Credit Card Reference Transaction payment type.\n"
},
"achAccountName": {
"type": "string",
"description": "The name of the account holder, which can be either a person or a company. This field is only required if the `type` field is set to `ACH`.\n"
},
"achAccountType": {
"enum": [
"BusinessChecking",
"Checking",
"Saving"
],
"type": "string",
"description": "The type of bank account associated with the ACH payment method. This field is only required if the `type` field is set to `ACH`.\n\nWhen creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, `Checking` preferably.\n"
},
"bankBranchCode": {
"type": "string",
"description": "The branch code of the bank used for Direct Debit. \n"
},
"bankCheckDigit": {
"type": "string",
"description": "The check digit in the international bank account number, which confirms the validity of the account. Applicable to direct debit payment methods."
},
"bankPostalCode": {
"type": "string",
"description": "The zip code or postal code of the direct debit bank."
},
"bankStreetName": {
"type": "string",
"description": "The name of the street of the direct debit bank."
},
"creditCardCity": {
"type": "string",
"description": "The city of the card holder's address. Applicable to credit card and\ndirect debit payment methods.\n"
},
"creditCardType": {
"type": "string",
"description": "The type of the credit card or debit card.\n\nPossible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).\n\n**Note:** This field is only returned for the Credit Card and Debit Card payment types.\n"
},
"identityNumber": {
"type": "string",
"description": "The identity number of the account holder or the cardholder.\n"
},
"creditCardState": {
"type": "string",
"description": "The state where the credit card holder stays.\n"
},
"deviceSessionId": {
"type": "string",
"description": "The session ID of the user when the `PaymentMethod` was created or updated.\n"
},
"existingMandate": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Indicates whether the mandate is an existing mandate.\n"
},
"mandateReceived": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Indicates whether the mandate is received from the gateway.\n"
},
"userReferenceId": {
"type": "string",
"description": "The identification reference of the user or customer account.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.\n"
},
"bankStreetNumber": {
"type": "string",
"description": "The number of the direct debit bank."
},
"bankTransferType": {
"enum": [
"AutomatischIncasso",
"LastschriftDE",
"LastschriftAT",
"DemandeDePrelevement",
"DirectDebitUK",
"Domicil",
"LastschriftCH",
"RID",
"OrdenDeDomiciliacion",
"Autogiro",
"Betalingsservice"
],
"type": "string",
"description": "Specifies the type of direct debit transfer. The value of this field is dependent on the country of the user.\n\nPossible Values: \n\n\n* `AutomatischIncasso` (NL)\n\n* `LastschriftDE` (Germany)\n\n* `LastschriftAT` (Austria)\n\n* `DemandeDePrelevement` (FR)\n\n* `DirectDebitUK` (UK)\n\n* `Domicil` (Belgium)\n\n* `LastschriftCH` (CH)\n\n* `RID` (Italy)\n\n* `OrdenDeDomiciliacion` (Spain)\n* `Autogiro` (Sweden)\n* `Betalingsservice` (Denmark)\n"
},
"creditCardCountry": {
"type": "string",
"description": "The country where the credit card holder stays.\n\nWhen creating a payment method through a translated UI or Payment Page, a country name in a translated language might be selected. \nRegardless of the country texts selected when creating the payment method, only the supported country name returns in this field. \nFor a complete list of supported country names, see <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions\" target=\"_blank\">View countries or regions</a>. \nInternationalization is not supported for the API field value.\n"
},
"mandateUpdateDate": {
"type": "string",
"format": "date",
"description": "The date on which the mandate was updated.\n"
},
"methodReferenceId": {
"type": "string",
"description": "The identification reference of the custom payment method.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query.\n"
},
"creditCardAddress1": {
"type": "string",
"description": "The first line of the card holder's address, which is often a street\naddress or business name. Applicable to credit card and direct debit\npayment methods.\n"
},
"creditCardAddress2": {
"type": "string",
"description": "The second line of the card holder's address. Applicable to credit card\nand direct debit payment methods.\n"
},
"methodSpecificData": {
"type": "string",
"description": "Other method-specific data of the payment method.\n"
},
"paymentRetryWindow": {
"type": "integer",
"format": "int32",
"description": "The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours.\n"
},
"mandateCreationDate": {
"type": "string",
"format": "date",
"description": "The date on which the mandate was created.\n"
},
"paymentMethodStatus": {
"enum": [
"Active",
"Closed",
"Scrubbed"
],
"type": "string",
"description": "The status of the payment method.\n"
},
"useDefaultRetryRule": {
"type": "boolean",
"description": "Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings.\n"
},
"achAccountNumberMask": {
"type": "string",
"description": "The masked bank account number associated with the ACH payment method. This field is only required if the `type` field is set to `ACH`.\n"
},
"creditCardHolderName": {
"type": "string",
"description": "The full name of the credit card holder.\n"
},
"creditCardMaskNumber": {
"type": "string",
"description": "The masked credit card number, such as `*********1112`.\n"
},
"creditCardPostalCode": {
"type": "string",
"description": "The postal code for the address of the credit card holder.\n"
},
"paypalPreapprovalKey": {
"type": "string",
"description": "The PayPal preapproval key.\n"
},
"lastTransactionStatus": {
"type": "string",
"description": "The status of the most recent transaction."
},
"numConsecutiveFailures": {
"type": "integer",
"format": "int32",
"description": "The number of consecutive failed payments for this payment method. It is reset to `0` upon successful payment. \n"
},
"bankTransferAccountName": {
"type": "string",
"description": "The name on the direct debit bank account."
},
"bankTransferAccountType": {
"type": "string",
"description": "The type of the customer's bank account. Applicable to direct debit\npayment methods.\n"
},
"lastTransactionDateTime": {
"type": "string",
"format": "date-time",
"description": "The date and time of the most recent transaction.\n"
},
"bankIdentificationNumber": {
"type": "string",
"description": "The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method."
},
"creditCardExpirationYear": {
"type": "integer",
"format": "int32",
"description": "Four-digit expiration year.\n"
},
"creditCardExpirationMonth": {
"type": "integer",
"format": "int32",
"maximum": 12,
"minimum": 1,
"description": "One or two digits expiration month.\n"
},
"businessIdentificationCode": {
"type": "string",
"description": "The business identification code for Swiss direct payment methods that use\nthe Global Collect payment gateway. Only applicable to direct debit\npayment methods in Switzerland with Global Collect.\n"
},
"totalNumberOfErrorPayments": {
"type": "integer",
"format": "int32",
"description": "The number of error payments that used this payment method."
},
"bankTransferAccountNumberMask": {
"type": "string",
"description": "This is a masked displayable version of the bank account number, used for\nsecurity purposes. For example: `XXXXXXXXX54321`.\n"
},
"lastFailedSaleTransactionDate": {
"type": "string",
"format": "date",
"description": "The date of the last failed attempt to collect payment with this payment\nmethod.\n"
},
"maxConsecutivePaymentFailures": {
"type": "integer",
"format": "int32",
"description": "The number of allowable consecutive failures Zuora attempts with the payment method before stopping.\n"
},
"totalNumberOfProcessedPayments": {
"type": "integer",
"format": "int32",
"description": "The number of successful payments that used this payment method."
}
}
}
ExpandedPaymentRun
{
"type": "object",
"title": "QueryPaymentRunResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the payment run.\n"
},
"batch": {
"type": "string",
"example": "Batch1",
"description": "The alias name given to a batch.\n"
},
"status": {
"enum": [
"Pending",
"Processing",
"Completed",
"Error",
"Canceled"
],
"type": "string",
"description": "The status of the created payment run.\n"
},
"endDate": {
"type": "string",
"description": "The end date of the payment run.\n"
},
"runDate": {
"type": "string",
"format": "date",
"description": "The date and time when the scheduled payment run is to be executed for\ncollecting payments.\n"
},
"runTime": {
"type": "integer",
"format": "int32",
"maximum": 23,
"minimum": 0,
"description": "The scheduled run time (hour) of day.\n"
},
"currency": {
"type": "string",
"example": "USD",
"description": "A currency defined in the web-based UI administrative settings.\n"
},
"repeatTo": {
"type": "string",
"description": "The end date of of the scheduled payment run.\n"
},
"timeZone": {
"type": "string",
"description": "Timezone of the scheduled payment run.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the payment run.\n"
},
"nextRunOn": {
"type": "string",
"format": "date",
"description": "The date when the next payment run is scheduled to run.\n"
},
"repeatFrom": {
"type": "string",
"description": "The start date of the scheduled payment run.\n"
},
"repeatType": {
"enum": [
"None",
"Daily",
"Weekly",
"Monthly"
],
"type": "string",
"description": "The repeat type of the payment run.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date used to determine which receivables to be collected in the\npayment run. \n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the payment run.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment run gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the payment run.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment run gets updated in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"weeklyOnDay": {
"enum": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri",
"Sat",
"Sun"
],
"type": "string",
"description": "The repeat day in a week. \n\nThis field is required if you set `repeatType` field to `Weekly`.\n"
},
"billingRunId": {
"type": "string",
"description": "The unique identifier of the billing run that the payment run is\nassociated with.\n"
},
"errorMessage": {
"type": "string",
"description": "The detailed information of the error response.\n"
},
"executedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment run is executed, in `yyyy-mm-dd\nhh:mm:ss` format. For example, 2024-03-01 11:30:37.\n"
},
"monthlyOnDay": {
"type": "string",
"description": "The repeat day in a month.\n"
},
"collectPayment": {
"type": "boolean",
"description": "Whether to process electronic payments during the execution of payment\nruns. \n"
},
"numberOfErrors": {
"type": "integer",
"format": "int32",
"description": "The number of payments with the status of `Error` and `Processing`.\n"
},
"billingCycleDay": {
"type": "string",
"example": 1,
"description": "The billing cycle day (BCD), the day of the month when a bill run\ngenerates invoices for the account. \n"
},
"numberOfInvoices": {
"type": "integer",
"format": "int32",
"description": "**Note:** This field is only available if you have the Invoice Settlement feature enabled.\n\nThe total number of invoices that are picked up for processing in the payment run.\n"
},
"numberOfPayments": {
"type": "integer",
"format": "int32",
"description": "The number of payments that are successfully processed in the payment run.\n"
},
"paymentGatewayId": {
"type": "string",
"format": "uuid",
"description": "The ID of the gateway instance that processes the payment.\n"
},
"paymentRunNumber": {
"type": "string",
"description": "Number of the payment run.\n"
},
"applyCreditBalance": {
"type": "boolean",
"description": "Whether to apply credit balances in the payment run. This field is only\navailable when you have Invoice Settlement feature disabled.\n"
},
"numberOfDebitMemos": {
"type": "integer",
"format": "int32",
"description": "The total number of debit memos that are picked up for processing in the payment run.\n\n**Note:** This field is only available if you have the Invoice Settlement feature enabled.\n"
},
"totalExecutionTime": {
"type": "integer",
"format": "int64",
"description": "The total time taken to execute the payment run in milliseconds.\n"
},
"autoApplyCreditMemo": {
"type": "boolean",
"description": "Whether to automatically apply a posted credit memo to one or more\nreceivables in the payment run.\n\n\n**Note:** This field is only available if you have [Invoice\nSettlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\nenabled. The Invoice Settlement feature is generally available as of Zuora\nBilling Release 296 (March 2021). This feature includes Unapplied\nPayments, Credit and Debit Memo, and Invoice Item Settlement. If you want\nto enable Invoice Settlement, see [Invoice Settlement Enablement and\nChecklist\nGuide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\nfor more information.\n"
},
"consolidatedPayment": {
"type": "boolean",
"description": "**Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information. \n\nWhether to process a single payment for all receivables that are due on an account.\n"
},
"numberOfCreditMemos": {
"type": "integer",
"format": "int32",
"description": "The total number of credit memos that are successfully processed in the\npayment run.\n\n\n**Note:** This field is only available if you have the Invoice Settlement\nfeature enabled.\n"
},
"numberOfUnprocessed": {
"type": "integer",
"format": "int32",
"description": "The number of billing documents with remaining positive balances after the\npayment run is completed.\n"
},
"autoApplyUnappliedPayment": {
"type": "boolean",
"description": "Whether to automatically apply unapplied payments to one or more\nreceivables in the payment run.\n\n\n**Note:** This field is only available if you have [Invoice\nSettlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\nenabled. The Invoice Settlement feature is generally available as of Zuora\nBilling Release 296 (March 2021). This feature includes Unapplied\nPayments, Credit and Debit Memo, and Invoice Item Settlement. If you want\nto enable Invoice Settlement, see [Invoice Settlement Enablement and\nChecklist\nGuide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\nfor more information.\n"
},
"numberofUnappliedPayments": {
"type": "integer",
"format": "int32",
"description": "The number of unapplied payments that are successfully processed in the\npayment run.\n\n\n**Note:** This field is only available if you have the Invoice Settlement\nfeature enabled.\n"
},
"processPaymentWithClosedPM": {
"type": "boolean",
"description": "Whether to process payments even if the default payment method is closed.\n\n\n**Note:** The **Process Electronic Payment** permission also needs to be\nallowed for a Manage Payment Runs role to work. See [Payments\nRoles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles)\nfor more information. \n"
},
"numberOfDebitMemosUnprocessed": {
"type": "integer",
"format": "int32",
"description": "The total number of debit memos that are not processed in the payment run.\n\n\n**Note:** This field is only available if you have the Invoice Settlement\nfeature enabled.\n"
},
"numberOfCreditBalanceAdjustments": {
"type": "integer",
"format": "int32",
"description": "**Note:** This field is only available if you have the Credit Balance\nfeature enabled.\n\n\nThe number of credit balance adjustments that are successfully processed\nin the payment run.\n"
}
}
}
ExpandedPaymentSchedule
{
"type": "object",
"title": "QueryPaymentScheduleResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the payment schedule.\n"
},
"number": {
"type": "string",
"description": "Number of the payment schedule.\n"
},
"period": {
"enum": [
"Monthly",
"Weekly",
"BiWeekly",
null
],
"type": "string",
"nullable": true,
"description": "For recurring payment schedule only. The period of payment generation.\n\nReturns `null` for custom payment schedules.\n"
},
"status": {
"enum": [
"Active",
"Canceled",
"Completed"
],
"type": "string",
"description": "The status of the payment schedule.\n\n- Active: There is still payment schedule item to process.\n\n- Canceled: After a payment schedule is canceled by the user, the\nschedule is marked as `canceled`.\n\n- Completed: After all payment schedule items are processed, the\nschedule is marked as `Completed`.\n"
},
"runHour": {
"type": "integer",
"format": "int32",
"maximum": 23,
"minimum": 0,
"description": "At which hour in the day in the tenant’s timezone the recurring\npayment schedule items will be collected.\n\nReturn `0` for custom payment schedules.\n"
},
"accountId": {
"type": "string",
"description": "ID of the account that owns the payment schedule.\n"
},
"invoiceId": {
"type": "string",
"description": "The unique identifier of the invoice to which the payment is applied.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The date when the first payment of this payment schedule is\nproccessed.\n"
},
"prepayment": {
"type": "boolean",
"description": "Indicates whether the payments created by the payment schedule are\nused as a reserved payment. This field is available only if the\nprepaid cash drawdown permission is enabled. See [Prepaid Cash with\nDrawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown)\nfor more information.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the payment schedule.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment schedule gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"debitmemoId": {
"type": "string",
"description": "The unique identifier of the debit memo to which the payment is applied.\n"
},
"description": {
"type": "string",
"description": "The description of the payment schedule.\n"
},
"occurrences": {
"type": "integer",
"format": "int32",
"description": "The number of payment schedule items that are created by this payment schedule.\n"
},
"totalAmount": {
"type": "number",
"description": "The total amount that will be collected by the payment\nschedule. \n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the payment schedule.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment schedule gets updated in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"nextPaymentDate": {
"type": "string",
"format": "date",
"description": "The date the next payment will be processed.\n"
},
"paymentOptionId": {
"type": "string",
"description": "The unique identifier of the payment option that is used to process\nthe payment schedule.\n"
},
"recentPaymentDate": {
"type": "string",
"format": "date",
"description": "The date the last payment was processed.\n"
},
"totalPaymentsErrored": {
"type": "integer",
"format": "int32",
"description": "The number of errored payments.\n"
},
"totalPaymentsProcessed": {
"type": "integer",
"format": "int32",
"description": "The number of processed payments.\n"
}
}
}
ExpandedPaymentScheduleItem
{
"type": "object",
"title": "QueryPaymentScheduleItemResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the payment schedule item.\n"
},
"amount": {
"type": "number",
"description": "The total amount of the payment schedule item.\n"
},
"number": {
"type": "string",
"description": "Number of the payment schedule item.\n"
},
"status": {
"enum": [
"Active",
"Canceled",
"Completed"
],
"type": "string",
"description": "The status of the payment schedule item.\n\n- Active: There is still payment schedule item to process.\n\n- Canceled: After a payment schedule is canceled by the user, the\nschedule is marked as `canceled`.\n\n- Completed: After all payment schedule items are processed, the\nschedule is marked as `Completed`.\n"
},
"balance": {
"type": "number",
"description": "The remaining balance of payment schedule item.\n"
},
"runHour": {
"type": "integer",
"format": "int32",
"maximum": 23,
"minimum": 0,
"description": "At which hour in the day in the tenant’s timezone the recurring\npayment schedule items will be collected.\n\nReturn `0` for custom payment schedules.\n"
},
"currency": {
"type": "string",
"description": "The currency in which the payment is made.\n\nNote: If this field was not specified, the default value is the currency set for the account.\n"
},
"accountId": {
"type": "string",
"description": "ID of the account that owns the payment schedule.\n"
},
"invoiceId": {
"type": "string",
"description": "The unique identifier of the invoice to which the payment is applied.\n"
},
"paymentId": {
"type": "string",
"description": "ID of the payment that is created by the payment schedule item, or linked to the payment schedule item. \nThis field is only available if the request doesn’t specify `zuora-version`, or `zuora-version` is set to a value equal to or smaller than\\_`336.0`.\n"
},
"prepayment": {
"type": "boolean",
"description": "Indicates whether the payments created by the payment schedule are\nused as a reserved payment. This field is available only if the\nprepaid cash drawdown permission is enabled. See [Prepaid Cash with\nDrawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown)\nfor more information.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the payment schedule item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment schedule item gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"debitmemoId": {
"type": "string",
"description": "The unique identifier of the debit memo to which the payment is applied.\n"
},
"description": {
"type": "string",
"description": "The description of the payment schedule item.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the payment schedule item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment schedule item gets updated in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"errorMessage": {
"type": "string",
"description": "The error message indicating if the error is related to the\nconfiguration or the payment collection.\n"
},
"scheduledDate": {
"type": "string",
"format": "date",
"description": "The scheduled date when the payment is processed.\n"
},
"paymentMethodId": {
"type": "string",
"description": "ID of the payment method that will pay the billing documents.\n"
},
"paymentOptionId": {
"type": "string",
"description": "The unique identifier of the payment option that is used to process\nthe payment schedule item.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "ID of the payment gateway that processes the payment.\n"
},
"cancellationReason": {
"type": "string",
"description": "The reason for the cancellation of payment schedule item. \n"
}
}
}
ExpandedPrepaidBalance
{
"type": "object",
"title": "QueryPrepaidBalanceResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the prepaid balance.\n"
},
"uOM": {
"type": "string",
"description": "The units of measure for prepayment charge. Units of measure\nare configured in the web-based UI. Your values depend on your\nconfiguration in **Billing Settings**.\n\n**Values**: a valid unit of measure\n"
},
"name": {
"type": "string",
"description": "The name of the prepaid balance.\n"
},
"account": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"balance": {
"type": "number",
"description": "The current prepaid balance.\n"
},
"endDate": {
"type": "string",
"format": "date",
"description": "End date of the validity period."
},
"accountId": {
"type": "string",
"description": "The ID of the customer account to which the prepaid balance belongs.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "Start date of the validity period."
},
"totalFund": {
"type": "number",
"description": "The total amount of all prepaid balance funds.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the payment application.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment application was created.\n"
},
"prepaidType": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "The type of the prepaid balance.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the payment application.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment application was last updated.\n"
},
"origSubscription": {
"$ref": "#/components/schemas/NestedSubscriptionOnExpand"
},
"origSubscriptionId": {
"type": "string",
"description": "If it belongs to a subscription, the original subscription ID.\n"
},
"prepaidBalanceState": {
"enum": [
"ACTIVE",
"EXPIRED"
],
"type": "string",
"description": "The state of the prepaid balance. \n"
}
}
}
ExpandedPrepaidBalanceFund
{
"type": "object",
"title": "QueryPrepaidBalanceFundResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the prepaid balance fund.\n"
},
"done": {
"type": "integer",
"format": "int32"
},
"source": {
"$ref": "#/components/schemas/NestedRatePlanChargeOnExpand"
},
"account": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"balance": {
"type": "number",
"description": "The remaining balance (remaining units) on the fund.\n"
},
"endDate": {
"type": "string",
"format": "date",
"description": "End date of the fund effective period.\n"
},
"priority": {
"enum": [
10,
50,
100
],
"type": "integer",
"format": "int32",
"description": "The priority of the Fund. Possible values include: 10(high), 50(medium),100(low)\n"
},
"sourceId": {
"type": "string",
"description": "The source Id of the fund. It is the original charge ID. \n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account to which the prepaid balance fund belongs.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "Start date of the fund effective period.\n"
},
"vpSummary": {
"$ref": "#/components/schemas/NestedValidityPeriodSummaryOnExpand"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the prepaid balance fund.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the prepaid balance fund was created.\n"
},
"totalBilled": {
"type": "number",
"description": "The total billed amount of a fund.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the prepaid balance fund.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the prepaid balance fund was last updated.\n"
},
"vpSummaryId": {
"type": "string"
},
"fundingPrice": {
"type": "number",
"description": "The price amount of a fund. A rounded value that follows the associated invoice owner's <a href=\"https://knowledgecenter.zuora.com/Quick_References/Rounding_and_Precision#Currency_rounding_rules\" target=\"_blank\">currency rounding rule</a>. \n\n**Calculation**: (Number of billing periods in one fund validity period) * (price in one billing period)\n"
},
"originFundId": {
"type": "string"
},
"totalBalance": {
"type": "number",
"description": "The total balance of a fund.\n"
},
"fundedBalance": {
"type": "number",
"description": "The total units of the fund. \n"
},
"rolloverCount": {
"type": "integer",
"format": "int32"
},
"fundSourceType": {
"enum": [
"CHARGE",
"ORDER_LINE_ITEM",
"CREDIT_MEMO_ITEM",
"DEBIT_MEMO_ITEM"
],
"type": "string",
"description": "The type of the Prepaid Balance Fund. \n"
},
"prepaidBalance": {
"$ref": "#/components/schemas/NestedPrepaidBalanceOnExpand"
},
"prepaidBalanceId": {
"type": "string",
"description": "The ID of the prepaid balance associated to which this prepaid balance fund belongs.\n"
},
"chargeSegmentNumber": {
"type": "integer",
"format": "int32",
"description": "The number of the charge segment. One prepaid balance fund can only belong to one charge segment.\n"
},
"originalFundEndDate": {
"type": "string",
"format": "date",
"description": "The original end date of the fund effective period.\n"
},
"rolloverApplyOption": {
"type": "string"
},
"originalFundingPrice": {
"type": "number",
"description": "The original price amount of a fund.\n"
},
"originalTotalBalance": {
"type": "number",
"description": "The original total balance of a fund.\n"
},
"rolloverValidityPeriodEndDate": {
"type": "string",
"format": "date",
"description": "End date of the rollover validity period.\n"
},
"rolloverValidityPeriodStartDate": {
"type": "string",
"format": "date",
"description": "Start date of the rollover validity period.\n"
}
}
}
ExpandedPrepaidBalanceTransaction
{
"type": "object",
"title": "QueryPrepaidBalanceTransactionResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the prepaid balance transaction.\n"
},
"fund": {
"$ref": "#/components/schemas/NestedPrepaidBalanceFundOnExpand"
},
"amount": {
"type": "number",
"description": "The amount of units to be adjusted to the prepaid balance (could be positive or negative).\n"
},
"fundId": {
"type": "string",
"description": "The ID of the prepaid balance fund.\n"
},
"account": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"balance": {
"type": "number",
"description": "The prepaid balance after a transaction.\n"
},
"sourceId": {
"type": "string",
"description": "The transaction source id (original Charge Id, Guided Usage Id, Order Line Item Id).\n"
},
"usageUom": {
"type": "string"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account on which the prepaid balance transaction occurs.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the prepaid balance transaction.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the prepaid balance transaction was created.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the prepaid balance transaction.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the prepaid balance transaction was last updated.\n"
},
"drawdownRate": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).\n"
},
"prepaidBalance": {
"$ref": "#/components/schemas/NestedPrepaidBalanceOnExpand"
},
"transactionDate": {
"type": "string",
"format": "date",
"description": "The date when the prepaid balance transaction occurs.\n"
},
"prepaidBalanceId": {
"type": "string",
"description": "The ID of the prepaid balance.\n"
},
"transactionSourceType": {
"enum": [
"CHARGE",
"ORDER_LINE_ITEM",
"USAGE"
],
"type": "string",
"description": "The type of the transaction source. \n"
},
"prepaidBalanceTransactionType": {
"enum": [
"PREPAYMENT",
"DRAWDOWN",
"PREPAYMENT_ADJUSTMENT",
"DRAWDOWN_ADJUSTMENT",
"DRAWDOWN_REVERSAL",
"PREPAYMENT_CREDIT_BACK",
"PREPAYMENT_CREDIT_BACK_REVERSAL"
],
"type": "string",
"description": "The type of the Prepaid Balance Transaction. \n"
}
}
}
ExpandedProcessedUsage
{
"type": "object",
"title": "QueryProcessedUsageResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the processed usage.\n"
},
"usage": {
"$ref": "#/components/schemas/NestedUsageOnExpand"
},
"amount": {
"type": "number",
"description": "The amount of the processed usage.\n"
},
"usageId": {
"type": "string",
"description": "The unique identifier of the usage.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the processed usage.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the processed usage was created.\n"
},
"invoiceItem": {
"$ref": "#/components/schemas/NestedInvoiceItemOnExpand"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the processed usage.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the processed usage was last updated.\n"
},
"invoiceItemId": {
"type": "string",
"description": "The unique identifier of the invoice item associated with the processed usage.\n"
},
"creditMemoItem": {
"$ref": "#/components/schemas/NestedCreditMemoItemOnExpand"
},
"creditMemoItemId": {
"type": "string",
"description": "The unique identifier of the credit memo item associated with the processed usage.\n"
},
"billingPeriodEndDate": {
"type": "string",
"description": "The end date of the billing period for the processed usage.\n"
},
"billingPeriodStartDate": {
"type": "string",
"description": "The start date of the billing period for the processed usage.\n"
}
}
}
ExpandedProduct
{
"type": "object",
"title": "QueryProductResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the product.\n"
},
"sKU": {
"type": "string",
"description": "The unique SKU for the product.\n"
},
"name": {
"type": "string",
"description": "The name of the product. This information is displayed in the product\ncatalog pages in the web-based UI.\n"
},
"category": {
"enum": [
"Base Products",
"Add On Services",
"Miscellaneous Products"
],
"type": "string",
"description": "Category of the product. Used by Zuora Quotes Guided Product Selector.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the product.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the product was created.\n"
},
"description": {
"type": "string",
"description": "A description of the product. \n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the product.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the product was last updated.\n"
},
"productNumber": {
"type": "string",
"description": "The product number of the product.\n"
},
"effectiveEndDate": {
"type": "string",
"format": "date",
"description": "The date when the product expires and can't be subscribed to anymore,\nin the `yyyy-mm-dd` format.\n"
},
"productRatePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedProductRatePlanOnExpand"
}
},
"effectiveStartDate": {
"type": "string",
"format": "date",
"description": "The date when the product becomes available and can be subscribed to, in the `yyyy-mm-dd` format.\n"
},
"allowFeatureChanges": {
"type": "boolean",
"default": false,
"description": "Controls whether to allow your users to add or remove features while creating or amending a subscription.\n"
}
}
}
ExpandedProductRatePlan
{
"type": "object",
"title": "QueryProductRatePlanResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the product rate plan.\n"
},
"name": {
"type": "string",
"description": "The name of the product rate plan.\n"
},
"grade": {
"type": "integer",
"format": "int32",
"description": "The grade of the product rate plan.\n\n\n**Note**: This field is in the **Early Adopter** phase. We are\nactively soliciting feedback from a small set of early adopters before\nreleasing it as generally available. If you want to join this early\nadopter program, submit a request at [Zuora Global\nSupport](http://support.zuora.com/).\n"
},
"product": {
"$ref": "#/components/schemas/NestedProductOnExpand"
},
"productId": {
"type": "string",
"description": "The unique identifier of the product to which this product rate\nplan belongs.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the product rate plan.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the product rate plan was created.\n"
},
"description": {
"type": "string",
"description": "A description of the product rate plan.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the product rate plan.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the product rate plan was last updated.\n"
},
"effectiveEndDate": {
"type": "string",
"format": "date",
"description": "Final date the rate plan is active, as `yyyy-mm-dd`. After this date,\nthe rate plan status is `Expired`.\n"
},
"effectiveStartDate": {
"type": "string",
"format": "date",
"description": "First date the rate plan is active (i.e., available to be subscribed\nto), as `yyyy-mm-dd`. Before this date, the status is `NotStarted`.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "The natural key of the product rate plan. \n"
},
"productRatePlanCharges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedPrpcOnExpand"
}
}
}
}
ExpandedProductRatePlanCharge
{
"type": "object",
"title": "QueryProductRatePlanChargeResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the product rate plan charge.\n"
},
"uOM": {
"type": "string",
"nullable": true,
"description": "Describes the Units of Measure (uom) configured in **Settings >\nBilling** for the productRatePlanCharges.\n"
},
"name": {
"type": "string",
"description": "Name of the product rate-plan charge. Not required to be unique.\n"
},
"taxCode": {
"type": "string",
"description": "Specifies the tax code for taxation rules; used by Zuora Tax.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive",
null
],
"type": "string",
"nullable": true,
"description": "Specifies how to define taxation for the charge; used by Zuora Tax.\n"
},
"taxable": {
"type": "boolean",
"description": "Specifies whether the charge is taxable; used by Zuora Tax. \n"
},
"isPrepaid": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled.\n\n\nIndicates whether this charge is a prepayment (topup) charge or a\ndrawdown charge. \n"
},
"chargeType": {
"enum": [
"OneTime",
"Recurring",
"Usage"
],
"type": "string",
"description": "Specifies the type of charge.\n"
},
"isRollover": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled.\n\n\nIt determines whether the rollover fields are needed.\n"
},
"prepaidUom": {
"type": "string",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled.\n\n\nUnit of measurement for a [prepayment\ncharge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"revRecCode": {
"type": "string",
"nullable": true,
"maxLength": 70,
"description": "Associates this product rate plan charge with a specific revenue\nrecognition code.\n"
},
"chargeModel": {
"enum": [
"Discount-Fixed Amount",
"Discount-Percentage",
"Flat Fee Pricing",
"Per Unit Pricing",
"Overage Pricing",
"Tiered Pricing",
"Tiered with Overage Pricing",
"Volume Pricing",
"Delivery Pricing",
"MultiAttributePricing",
"PreratedPerUnit",
"PreratedPricing`",
"HighWatermarkVolumePricing",
"HighWatermarkTieredPricing"
],
"type": "string",
"description": "Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the product rate plan charge.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the product rate plan charge was created.\n"
},
"description": {
"type": "string",
"description": "Description of the product rate plan charge.\n"
},
"drawdownUom": {
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled.\n\n\nUnit of measurement for a [drawdown\ncharge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).\n"
},
"isCommitted": {
"type": "boolean",
"description": "Indicates whether the charge is commited.\n"
},
"maxQuantity": {
"type": "number",
"description": "The maximum number of units for this charge. This field and the `minQuantity` field can be used to create a range of units allowed in a product rate plan charge.\n"
},
"minQuantity": {
"type": "number",
"description": "The minimum number of units for this charge. This field and the `maxQuantity` field can be used to create a range of units allowed in a product rate plan charge.\n"
},
"ratingGroup": {
"type": "string",
"nullable": true,
"description": "Specifies a rating group based on which usage records are rated.\n\nPossible values:\n\n- `ByBillingPeriod` (default): The rating is based on all the usages in a billing period.\n- `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. \n- `ByUsageRecord`: The rating is based on each usage record.\n- `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`).\n- `ByGroupId`: The rating is based on all the usages in a custom group.\n\n**Note:** \n- The `ByBillingPeriod` value can be applied for all charge models. \n- The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. \n- The `ByGroupId` value is only available if you have the Active Rating feature enabled.\n- Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`.\n"
},
"upToPeriods": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Specifies the length of the period during which the charge is active.\nIf this period ends before the subscription ends, the charge ends when\nthis period ends.\n\nIf the subscription end date is subsequently changed through a\nRenewal, or Terms and Conditions amendment, the charge end date will\nchange accordingly up to the original period end.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the product rate plan charge.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the product rate plan charge was last updated.\n"
},
"billCycleDay": {
"type": "integer",
"format": "int64",
"maximum": 31,
"minimum": 1,
"description": "Sets the bill cycle day (BCD) for the charge. The BCD determines which\nday of the month customer is billed. The BCD value in the account can\noverride the BCD in this object.\n"
},
"creditOption": {
"enum": [
"TimeBased",
"ConsumptionBased",
"FullCreditBack"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled.\n\n\nThe way to calculate credit. See [Credit\nOption](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)\nfor more information. \n"
},
"drawdownRate": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).\n"
},
"triggerEvent": {
"enum": [
"ContractEffective",
"ServiceActivation",
"CustomerAcceptance",
"SpecificDate"
],
"type": "string",
"description": "Specifies when to start billing the customer for the charge.\n\nValues: one of the following:\n- `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.\n- `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access.\n- `CustomerAcceptance` is when the customer accepts the services or products for a subscription. \n- `SpecificDate` is the date specified.\n"
},
"billCycleType": {
"enum": [
"DefaultFromCustomer",
"SpecificDayofMonth",
"SubscriptionStartDay",
"ChargeTriggerDay",
"SpecificDayofWeek",
"TermStartDay",
"TermEndDay"
],
"type": "string",
"description": "Specifies how to determine the billing day for the\ncharge. \n"
},
"billingPeriod": {
"enum": [
"Month",
"Quarter",
"Annual",
"Semi-Annual",
"Specific Months",
"Subscription Term",
"Week",
"Specific Weeks",
"Specific Days"
],
"type": "string",
"description": "The billing period for the charge. The start day of the billing period\nis also called the bill cycle day (BCD).\n"
},
"billingTiming": {
"enum": [
"IN_ADVANCE",
"IN_ARREARS"
],
"type": "string",
"description": "The billing timing for this charge.\n"
},
"discountLevel": {
"enum": [
"rateplan",
"subscription",
"account",
null
],
"type": "string",
"nullable": true,
"description": "The application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge.\n"
},
"includedUnits": {
"type": "number",
"description": "Specifies the number of units in the base set of units.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year",
"Per_Specific_Months"
],
"type": "string",
"description": "The list price base for the product rate plan charge.\n\nThis field is only applicable for recurring charges.\n"
},
"rolloverApply": {
"enum": [
"ApplyFirst",
"ApplyLast"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the priority of rollover, which is either first or last.\n"
},
"accountingCode": {
"type": "string",
"maxLength": 100,
"description": "The accounting code for the charge. Accounting codes group\ntransactions that contain similar accounting attributes.\n"
},
"commitmentType": {
"enum": [
"UNIT",
"CURRENCY"
],
"type": "string",
"description": "**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage\" target=\"_blank\">Unbilled Usage</a> feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to `133` or higher. Otherwise, an error occurs. \n\nThis field defines the type of commitment. A prepaid charge can be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can only be `CURRENCY` type. For topup(recurring or one-time) charges, this field indicates what type of funds are created. \n* If UNIT, it will create a fund with given prepaidUom.\n* If CURRENCY, it will create a fund with the currency amount calculated in list price.\n \nFor drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges.\n"
},
"numberOfPeriod": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Specifies the number of periods to use when calculating charges in an overage smoothing charge model.\nThis field is ued when overage smoothing model is `RollingWindow` or `Rollover`.\n"
},
"smoothingModel": {
"type": "string",
"nullable": true,
"description": "Specifies the smoothing model for an overage smoothing charge model or\nan tiered with overage model, which is an advanced type of a usage\nmodel that avoids spikes in usage charges. If a customer's usage\nspikes in a single period, then an overage smoothing model eases\noverage charges by considering usage and multiple periods.\n\n\nOne of the following values shows which smoothing model will be\napplied to the charge when `Overage` or `Tiered with Overage` is used:\n\n\n- `RollingWindow` considers a number of periods to smooth usage. The\nrolling window starts and increments forward based on billing\nfrequency. When allowed usage is met, then period resets and a new\nwindow begins.\n\n- `Rollover` considers a fixed number of periods before calculating\nusage. The net balance at the end of a period is unused usage, which\nis carried over to the next period's balance.\n"
},
"applyDiscountTo": {
"enum": [
"ONETIME",
"RECURRING",
"USAGE",
"ONETIMERECURRING",
"ONETIMEUSAGE",
"RECURRINGUSAGE",
"ONETIMERECURRINGUSAGE",
null
],
"type": "string",
"nullable": true,
"description": "Indicates which type of charge the discount charge applies to.\n"
},
"defaultQuantity": {
"type": "number",
"nullable": true,
"description": "The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n"
},
"discountClassId": {
"type": "string",
"nullable": true,
"description": "ID of the class the discount belongs to. The discount class defines the order in which discount product rate plan charges are applied.\n\nFor more information, see [Manage Discount Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).\n"
},
"prepaidQuantity": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).\n"
},
"productRatePlan": {
"$ref": "#/components/schemas/NestedProductRatePlanOnExpand"
},
"rolloverPeriods": {
"type": "integer",
"format": "int64",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the number of rollover periods, it is restricted to 3.\n"
},
"upToPeriodsType": {
"enum": [
"Billing_Periods",
"Days",
"Weeks",
"Months",
"Years",
null
],
"type": "string",
"nullable": true,
"description": "The period type used to define when the charge ends.\n"
},
"endDateCondition": {
"enum": [
"Subscription_End",
"One_Time",
"Fixed_Period",
"Specific_End_Date"
],
"type": "string",
"description": "The end date condition for this charge.\n"
},
"isStackedDiscount": {
"type": "boolean",
"description": "**Note**: This field is only applicable to the Discount - Percentage charge model.\n\nThis field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:\n - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.\n - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.\n\nFor more information, see [Stacked discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).\n"
},
"priceChangeOption": {
"enum": [
"NoChange",
"SpecificPercentageValue",
"UseLatestProductCatalogPricing"
],
"type": "string",
"default": "NoChange",
"nullable": true,
"description": "Applies an automatic price change when a termed subscription is\nrenewed and the following applies:\n\n\n1. AutomatedPriceChange setting is on\n\n2. Charge type is not one-time\n\n3. Charge model is not discount fixed amount\n"
},
"productRatePlanId": {
"type": "string",
"description": "The unique identifier of the product rate plan to which this product rate plan charge belongs.\n"
},
"deliveryScheduleId": {
"type": "string",
"description": "The unique identifier of the delivery schedule associated with the\nproduct rate plan charge. This field is applicable only when this charge is\nusing Delivery Pricing charge model.\n"
},
"validityPeriodType": {
"enum": [
"SUBSCRIPTION_TERM",
"ANNUAL",
"SEMI_ANNUAL",
"QUARTER",
"MONTH"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled.\n\n\nThe period in which the prepayment units are valid to use as defined\nin a [prepayment\ncharge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"weeklyBillCycleDay": {
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string",
"description": "Specifies which day of the week as the bill cycle day (BCD) for the\ncharge.\n\n\nThis feature is in **Limited Availability**. If you wish to have\naccess to the feature, submit a request at [Zuora Global\nSupport](http://support.zuora.com/). \n"
},
"prepaidOperationType": {
"enum": [
"topup",
"drawdown",
null
],
"type": "string",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe type of this charge. It is either a prepayment (topup) charge or a drawdown charge. \n"
},
"prepaidTotalQuantity": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"rolloverPeriodLength": {
"type": "integer",
"format": "int32",
"default": null,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period length of the rollover fund.\n"
},
"specificBillingPeriod": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "When the billing period is set to `Specific` Months then this positive\ninteger reflects the number of months for billing period charges.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "The number of months for the list price base of the charge. The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.\n"
},
"billingPeriodAlignment": {
"enum": [
"AlignToCharge",
"AlignToSubscriptionStart",
"AlignToTermStart",
"AlignToTermEnd"
],
"type": "string",
"description": "The billing period alignment setting for this charge.\n"
},
"deferredRevenueAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the deferred revenue account for this charge.\n\n\nThis feature is in **Limited Availability**. If you wish to have\naccess to the feature, submit a request at [Zuora Global\nSupport](http://support.zuora.com/). \n"
},
"legacyRevenueReporting": {
"type": "boolean",
"description": "Indicates whether to use the legacy revenue reporting for this charge.\n"
},
"revRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate",
null
],
"type": "string",
"nullable": true,
"maxLength": 22,
"description": "Specifies when revenue recognition begins.\n"
},
"priceIncreasePercentage": {
"type": "number",
"maximum": 100,
"minimum": -100,
"nullable": true,
"description": "Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the `PriceChangeOption` value to `SpecificPercentageValue`.\n\n1. AutomatedPriceChange setting is on\n2. Charge type is not one-time\n3. Charge model is not discount fixed amount\n\nValues: a decimal between -100 and 100\n"
},
"usageRecordRatingOption": {
"type": "string",
"nullable": true,
"description": "Determines how Zuora processes usage records for per-unit usage\ncharges. \n"
},
"overageCalculationOption": {
"enum": [
"EndOfSmoothingPeriod",
"PerBillingPeriod",
null
],
"type": "string",
"nullable": true,
"description": "Value specifies when to calculate overage charges.\n"
},
"recognizedRevenueAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the recognized revenue account for this charge.\n - Required when the Allow Blank Accounting Code setting is No.\n - Optional when the Allow Blank Accounting Code setting is Yes.\n\nThis 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"
},
"priceUpsellQuantityStacked": {
"type": "boolean",
"description": "Indicates whether the price upsell quantity is stacked.\n"
},
"productRatePlanChargeTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedPrpcTierOnExpand"
}
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"productRatePlanChargeNumber": {
"type": "string",
"description": "The natural key of the product rate plan charge.\n"
},
"contractAssetAccountingCodeId": {
"type": "string",
"description": "The type associated with the contract asset accounting code. \n\n\n**Note**: This field is only available if you have the Zuora Billing -\nRevenue Integration feature enabled.\n"
},
"overageUnusedUnitsCreditOption": {
"enum": [
"NoCredit",
"CreditBySpecificRate"
],
"type": "string",
"nullable": true,
"description": "Determines whether to credit the customer with unused units of usage.\n"
},
"useTenantDefaultForPriceChange": {
"type": "boolean",
"description": "Shows the tenant-level percentage uplift value for an automatic price\nchange to a termed subscription's renewal. You set the tenant uplift\nvalue in the web-based UI: **Settings > Billing > Define Default\nSubscription Settings**.\n"
},
"deferredRevenueAccountingCodeId": {
"type": "string",
"nullable": true,
"description": "The type associated with the deferred revenue accounting code, such as\nDeferred Revenue. \n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "The type of the accounting code for accounts receivable.\n"
},
"adjustmentRevenueAccountingCodeId": {
"type": "string",
"description": "The type associated with the adjustment revenue accounting code. \n\n\n**Note**: This field is only available if you have the Zuora Billing -\nRevenue Integration feature enabled.\n"
},
"contractLiabilityAccountingCodeId": {
"type": "string",
"description": "The accounting code for contract liability. \n\n\n**Note**: This field is only available if you have the Zuora Billing -\nRevenue Integration feature enabled.\n"
},
"recognizedRevenueAccountingCodeId": {
"type": "string",
"description": "The accounting code for recognized revenue, such as Monthly Recurring\nCharges or Overage Charges. \n"
},
"useDiscountSpecificAccountingCode": {
"type": "boolean",
"nullable": true,
"description": "Determines whether to define a new accounting code for the new\ndiscount charge.\n"
},
"adjustmentLiabilityAccountingCodeId": {
"type": "string",
"description": "The type associated with the adjustment liability accounting code. \n\n\n**Note**: This field is only available if you have the Zuora Billing -\nRevenue Integration feature enabled.\n"
},
"unbilledReceivablesAccountingCodeId": {
"type": "string",
"nullable": true,
"description": "The accounting code for unbilled receivables. \n\n\n**Note**: This field is only available if you have the Zuora Billing -\nRevenue Integration feature enabled.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related rate plan charges and order line items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.\n"
},
"contractRecognizedRevenueAccountingCodeId": {
"type": "string",
"description": "The accounting code for contract recognized revenue. \n\n\n**Note**: This field is only available if you have the Zuora Billing -\nRevenue Integration feature enabled.\n"
}
}
}
ExpandedProductRatePlanChargeTier
{
"type": "object",
"title": "QueryProductRatePlanChargeTierResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the product rate plan charge tier.\n"
},
"tier": {
"type": "integer",
"format": "int32",
"description": "A unique number that identifies the tier that the price applies to.\n"
},
"price": {
"type": "number",
"format": "double",
"description": "The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.\n"
},
"active": {
"type": "boolean",
"description": "Indicates whether the product rate plan charge tier is active.\n"
},
"currency": {
"type": "string",
"description": "The valid code corresponding to the currency for the tier's price.\n"
},
"isDefault": {
"type": "boolean",
"description": "Indicates whether the tier is the default tier. The default tier is the\ntier that is used when the usage does not fall into any of the defined\ntiers.\n"
},
"endingUnit": {
"type": "number",
"description": "The end number of a range of units for the tier. This field is\napplicable for charges based on the Tiered Pricing or Tiered with\nOverage Pricing charge model.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the product rate plan charge tier.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the product rate plan charge tier gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"priceFormat": {
"enum": [
"FlatFee",
"PerUnit"
],
"type": "string",
"description": "Indicates if pricing is a flat fee or is per unit. This field is for tiered and volume pricing models only.\n\n**Note:** The values `Flat Fee` and `Per Unit` (with spaces) is valid for create or update calls.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the product rate plan charge tier.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the product rate plan charge tier was last updated.\n"
},
"overagePrice": {
"type": "number",
"format": "double",
"description": "Indicates whether the price is an overage price, which is the price when usage surpasses the last defined tier.\n"
},
"startingUnit": {
"type": "number",
"description": "The starting number of a range of units for the tier. This field is\napplicable for charges based on the Tiered Pricing or Tiered with\nOverage Pricing charge model.\n"
},
"includedUnits": {
"type": "number",
"description": "Specifies the number of units in the base set of units.\n"
},
"discountAmount": {
"type": "number",
"format": "double",
"description": "The specific amount for a fixed discount. This field is applicable for charges based on the Discount-Fixed Amount charge model.\n"
},
"discountPercentage": {
"type": "number",
"format": "double",
"description": "The percentage of discount for a percentage discount. This field is applicable for charges based on the Discount-Percentage charge model.\n"
},
"productRatePlanCharge": {
"$ref": "#/components/schemas/NestedPrpcOnExpand"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The unique identifier of the product rate plan charge that the tier\nbelongs to.\n"
},
"productChargeDefinitionId": {
"type": "string",
"description": "The unique identifier of the product rate plan charge definition that\nthe tier belongs to.\n"
}
}
}
ExpandedRatePlan
{
"type": "object",
"title": "QueryRatePlanResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the rate plan.\n"
},
"name": {
"type": "string",
"description": "The name of the rate plan.\n"
},
"productId": {
"type": "string",
"description": "The unique identifier of the product associated with the rate plan.\n"
},
"amendmentId": {
"type": "string",
"description": "The unique identifier of the amendment made to the subscription.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the rate plan.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the rate plan was created.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the rate plan.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the rate plan was last updated.\n"
},
"subscription": {
"$ref": "#/components/schemas/NestedSubscriptionOnExpand"
},
"amendmentType": {
"type": "string",
"description": "The type of amendment associated with the rate plan. This field only applies to amendment rate plans.\n"
},
"invoiceOwnerId": {
"type": "string",
"description": "The unique identifier of the account that will pay the invoice.\n"
},
"subscriptionId": {
"type": "string",
"description": "The unique identifier of the subscription associated with the rate plan.\n"
},
"productRatePlan": {
"$ref": "#/components/schemas/NestedProductRatePlanOnExpand"
},
"ratePlanCharges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedRatePlanChargeOnExpand"
}
},
"productRatePlanId": {
"type": "string",
"description": "The unique identifier of the product rate plan that the rate plan is based on.\n"
},
"originalRatePlanId": {
"type": "string",
"description": "The original ID of the subscription rate plan, which is the ID of the subscription rate plan in the version-1 subscription.\n"
},
"subscriptionOfferId": {
"type": "string",
"description": "The unique identifier of the subscription offer associated with the rate plan.\n"
},
"subscriptionOwnerId": {
"type": "string",
"description": "The unique identifier of the account that owns the subscription.\n"
},
"externallyManagedPlanId": {
"type": "string",
"description": "Indicates the unique identifier for the rate plan purchased on a\nthird-party store. This field is used to represent a subscription rate\nplan created through third-party stores.\n"
},
"subscriptionRatePlanNumber": {
"type": "string",
"description": "The number of the rate plan in the subscription.\n"
}
}
}
ExpandedRatePlanCharge
{
"type": "object",
"title": "QueryRatePlanChargeResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the rate plan charge.\n"
},
"mRR": {
"type": "number",
"description": "Monthly recurring revenue (MRR) is the amount of recurring\ncharges in a given month. The MRR calculation doesn't include one-time\ncharges nor usage charges. **Character limit**: 16 **Values**: automatically\ngenerated \n"
},
"tCV": {
"type": "number",
"format": "double",
"description": " The total contract value (TCV) is the value of a single rate plan charge in a subscription over the lifetime of the subscription. This value does not represent all charges on the subscription. The TCV includes recurring charges and one-time charges, but it doesn't include usage charge.\n**Character limit**: 16 **Values**: automatically generated "
},
"uOM": {
"type": "string",
"description": " Specifies the units to measure usage.\n**Character limit**: 25 **Values**: inherited from `ProductRatePlanCharge.UOM` "
},
"dMRC": {
"type": "number",
"description": "A delta monthly recurring charge is the change in monthly\nrecurring revenue caused by an amendment or a new subscription. \n\n**Character limit**: 16 \n\n**Values**: automatically generated\n"
},
"dTCV": {
"type": "number",
"description": "After an Amendment, the change in the total contract value\\\n\\ (TCV) amount for this charge, compared with its previous value.\n\n**Character limit**: 16\n\n**Values**: automatically generated \n"
},
"name": {
"type": "string",
"description": "The name of the rate plan charge. **Character limit**: 100\n**Values**: automatically generated \n"
},
"segment": {
"type": "integer",
"format": "int32",
"description": "The identifying number of the subscription rate plan segment. Segments are numbered sequentially, starting with 1.\n**Character limit**: 2 **Values**: automatically generated "
},
"version": {
"type": "integer",
"format": "int64",
"description": "The version of the rate plan charge. Each time a charge is amended, Zuora creates a new version of the rate plan charge. **Character limit**: 5 **Values**: automatically generated."
},
"quantity": {
"type": "number",
"description": " The default quantity of units, such as the number of authors in a hosted wiki service. Valid for all charge models except for Flat Fee pricing.\n**Character limit**: 16 **Values**: a valid quantity value "
},
"ratePlan": {
"$ref": "#/components/schemas/NestedRatePlanOnExpand"
},
"isPrepaid": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled.\n\n\nIndicates whether this charge is a prepayment (topup) charge or a\ndrawdown charge. \n"
},
"chargeType": {
"type": "string",
"description": "Specifies the type of charge.\n\n**Values**: inherited from `ProductRatePlanCharge.ChargeType`\n"
},
"isRollover": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nIt determines whether the rollover fields are needed.\n"
},
"originalId": {
"type": "string",
"description": "The original ID of the rate plan charge. **Character limit**: 32 **Values**: automatically generated "
},
"prepaidUOM": {
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nUnit of measurement for a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"ratePlanId": {
"type": "string",
"description": "The unique identifier of the rate plan to which this rate plan charge belongs.\n"
},
"revRecCode": {
"type": "string",
"description": "Associates this product rate plan charge with a specific revenue recognition code.\n\n**Character limit**: 70\n\n**Values**: inherited from `ProductRatePlanCharge.RevRecCode` or a valid revenue recognition code\n\n**Note**: Unless overridden, this value changes if `ProductRatePlanCharge.RevRecCode` is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.RevRecCode` is updated. "
},
"chargeModel": {
"type": "string",
"description": "Determines how to evaluate charges. Charge models must be\\\n\\ individually activated in the web-based UI.\n\n**Values**: inherited from `ProductRatePlanCharge.ChargeModel` \n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the rate plan charge.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the rate plan charge was created.\n"
},
"description": {
"type": "string",
"description": "A description of the rate plan charge. \n"
},
"drawdownUom": {
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nUnit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).\n"
},
"isCommitted": {
"type": "boolean",
"description": "Indicates whether the rate plan charge is commited.\n"
},
"isProcessed": {
"type": "boolean",
"description": "Indicates whether the rate plan charge has been processed.\n"
},
"ratingGroup": {
"enum": [
"ByBillingPeriod",
"ByUsageStartDate",
"ByUsageRecord",
"ByUsageUpload",
"ByGroupId"
],
"type": "string",
"description": "A rating group based on which usage records are rated. Only applicable to Usage charges.\n\nPossible values:\n\n- `ByBillingPeriod`: The rating is based on all the usages in a billing period.\n- `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. \n- `ByUsageRecord`: The rating is based on each usage record.\n- `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`).\n- `ByGroupId`: The rating is based on all the usages in a custom group.\n\nFor more information, see [Usage rating by group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group).\n"
},
"triggerDate": {
"type": "string",
"format": "date",
"description": " The date when the charge becomes effective and billing begins, in `yyyy-mm-dd` format. This field is required if the `TriggerEvent` field value is `SpecificDate`.\n**Character limit**: 29 "
},
"upToPeriods": {
"type": "integer",
"format": "int64",
"description": "Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.\n\n**Character limit**: 5 \n\n**Values**: inherited from `ProductRatePlanCharge.UpToPeriods` **Note**:\n\n- You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is only applicable only when the `EndDateCondition` field is set to `FixedPeriod`.\n- You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment.\n- Use this field to override the value in `ProductRatePlanCharge.UpToPeriod`.\n- If you override the value in this field, enter a whole number between 0 and 65535, exclusive.\n- If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the rate plan charge.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the rate plan charge was last updated.\n"
},
"billCycleDay": {
"type": "integer",
"format": "int64",
"description": "Indicates the charge's billing cycle day (BCD), which is\\\n\\ when bill runs generate invoices for charges associated with the product\\\n\\ rate plan charge or the account. \n\n**Values**: inherited from `ProductRatePlanCharge.BillCycleDay` \n"
},
"chargeNumber": {
"type": "string",
"description": "A unique number that identifies the charge. This number is returned as a string.\n\n**Values**: one of the following:\n- automatically generated if left `null`\n- a unique number of 50 characters or fewer\n"
},
"creditOption": {
"enum": [
"TimeBased",
"ConsumptionBased",
"FullCreditBack"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. \n\nThe way to calculate credit. See [Credit Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option) for more information.\n"
},
"drawdownRate": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).\n"
},
"triggerEvent": {
"type": "string",
"description": "Specifies when to start billing the customer for the charge.\n**Note: **This field can be passed through the Subscribe and Amend calls and will override the default value set on the Product Rate Plan Charge.\n\n**Character limit**: 18 \n\n**Values**: inherited from `ProductRatePlanCharge.TriggerEvent` and can be one of the following values:\n\n- `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.\n- `ServiceActivation` is when the services or products for a subscription have been activated and the customers have access.\n- `CustomerAcceptance` is when the customer accepts the services or products for a subscription.\n- `SpecificDate` is valid only on the RatePlanCharge.\n"
},
"billCycleType": {
"type": "string",
"description": "Specifies how to determine the billing day for the charge.\\n\\\n\n**Values**: inherited from `ProductRatePlanCharge.BillCycleType`\\\n\\ **Note:** You can override the value inherited from the Product Rate\\\n\\ Plan Charge, but only when creating a new subscription or a New Product\\\n\\ amendment. \n"
},
"billingPeriod": {
"type": "string",
"description": "Allows billing period to be overridden on rate plan charge.\\n\\\n****Values**: **inherited from `ProductRatePlanCharge.BillingPeriod` **Note:**\\\n\\ You can override the value inherited from the Product Rate Plan Charge,\\\n\\ but only when creating a new subscription or a New Product amendment. \n"
},
"billingTiming": {
"enum": [
"In Advance",
"In Arrears"
],
"type": "string",
"description": "The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types.\n\n**Note:** You can override the value inherited from the Product Rate Plan Charge when a subscription has a recurring charge type.\n"
},
"discountLevel": {
"enum": [
"rateplan",
"subscription",
"account"
],
"type": "string",
"description": "Application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge.\n"
},
"isLastSegment": {
"type": "boolean",
"description": "Indicates if the segment of the rate plan charge is the most recent segment. **Character limit**: 5 **Values**: automatically generated."
},
"listPriceBase": {
"enum": [
"Per Billing Period",
"Per Month",
"Per Week",
"Per Year",
"Per Specific Months"
],
"type": "string",
"description": "The list price base for the product rate plan charge.\n"
},
"rolloverApply": {
"enum": [
"ApplyFirst",
"ApplyLast"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the priority of rollover, which is either first or last.\n"
},
"accountingCode": {
"type": "string",
"description": "The accounting code for the charge. Accounting codes group\\\n\\ transactions that contain similar accounting attributes.\n\n**Values**: inherited from `ProductRatePlanCharge.AccountingCode`\\n\\\n\\n**Note**: This value changes if `ProductRatePlanCharge.AccountingCode`\\\n\\ is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge`\\\n\\ do not change when `ProductRatePlanCharge.AccountingCode` is updated. \n"
},
"commitmentType": {
"enum": [
"UNIT",
"CURRENCY"
],
"type": "string",
"description": "**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage\" target=\"_blank\">Unbilled Usage</a> feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to `133` or higher. Otherwise, an error occurs. \n\nThis field defines the type of commitment. A prepaid charge can be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can only be `CURRENCY` type. For topup(recurring or one-time) charges, this field indicates what type of funds are created. \n* If UNIT, it will create a fund with given prepaidUom.\n* If CURRENCY, it will create a fund with the currency amount calculated in list price.\n \nFor drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges.\n"
},
"invoiceOwnerId": {
"type": "string",
"description": "ID of the account that will pay the billing documents for the subscription.\n"
},
"subscriptionId": {
"type": "string",
"description": "The unique identifier of the subscription to which the rate plan charge belongs.\n"
},
"applyDiscountTo": {
"type": "string",
"description": "Specifies the type of charges a specific discount applies to. \n**Values**: inherited from `ProductRatePlanCharge.ApplyDiscountTo` \n"
},
"numberOfPeriods": {
"type": "integer",
"format": "int64",
"description": "Specifies the number of periods to use when calculating charges in an overage smoothing charge model. **Character limit**: 5 **Values**: inherited from `ProductRatePlanCharge.NumberOfPeriod` "
},
"prepaidQuantity": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).\n"
},
"prorationOption": {
"type": "string",
"description": "Determines how to prorate charges when a subscription is created or amended.\n"
},
"rolloverPeriods": {
"type": "integer",
"format": "int64",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the number of rollover periods, it is restricted to 3.\n"
},
"specificEndDate": {
"type": "string",
"format": "date",
"description": "The specific date on which the charge ends, in `yyyy-mm-dd` format.\n\n**Character limit**: 29 \n\n**Note**:\n\n- This field is only applicable when the `EndDateCondition` field is set to `SpecificEndDate`.\n- If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date.\n"
},
"upToPeriodsType": {
"enum": [
"Billing Periods",
"Days",
"Weeks",
"Months",
"Years"
],
"type": "string",
"default": "Billing Periods",
"description": "The period type used to define when the charge ends. This field can be updated when **Status** is `Draft`. \n\n**Note**:\n\n- You must use this field together with the `UpToPeriods` field to specify the time period.\n- This field is only applicable only when the `EndDateCondition` field is set to `FixedPeriod`.\n"
},
"amendedByOrderOn": {
"type": "string",
"format": "date",
"description": "The date when the rate plan charge is amended through an order\nor amendment. This field is to standardize the booking date\ninformation to increase audit ability and traceability of data\nbetween Zuora Billing and Zuora Revenue. It is mapped as the\nbooking date for a sale order line in Zuora Revenue.\n"
},
"effectiveEndDate": {
"type": "string",
"format": "date",
"description": "Start date when the rate plan charge becomes active, as `yyyy-mm-dd`.\n"
},
"endDateCondition": {
"enum": [
"Subscription_End",
"Fixed_Period",
"Specific_End_Date"
],
"type": "string",
"description": "Condition for the charge to become inactive.\n\n- If the value of this field is `Fixed_Period`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields.\n- If the value of this field is `Specific_End_Date`, use the `specificEndDate` field to specify the date when the charge becomes inactive.\n"
},
"invoiceScheduleId": {
"type": "string",
"description": "The unique identifier of the invoice schedule associated with the subscription.\n"
},
"originalOrderDate": {
"type": "string",
"format": "date",
"description": "The date when the rate plan charge is created through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sales order line in Zuora Revenue.\n"
},
"priceChangeOption": {
"type": "string",
"description": "Applies an automatic price change when a termed subscription is renewed.\n\n**Values**: one of the following:\n\n- `NoChange` (default)\n- `SpecificPercentageValue`\n- `UseLatestProductCatalogPricing`\n"
},
"chargedThroughDate": {
"type": "string",
"format": "date",
"maxLength": 29,
"description": "The date through which a customer has been billed for the charge.\n"
},
"effectiveStartDate": {
"type": "string",
"format": "date",
"description": "Final date the rate plan is active, as `yyyy-mm-dd`.\n"
},
"numberOfDeliveries": {
"type": "number",
"description": "Number of deliveries in the billing period for the charge segment.\n\nThe `numberOfDeliveries` is used for the Delivery Pricing charge model only. \n\n**Note**: The Delivery Pricing charge model 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. You can check **Delivery Pricing** in **Billing Settings** > **Enable Charge Types / Models**.\n"
},
"validityPeriodType": {
"enum": [
"SUBSCRIPTION_TERM",
"ANNUAL",
"SEMI_ANNUAL",
"QUARTER",
"MONTH"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"weeklyBillCycleDay": {
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string",
"description": "Specifies which day of the week as the bill cycle day (BCD) for the charge.\n"
},
"subscriptionOwnerId": {
"type": "string",
"description": "ID of the account that owns the subscription.\n"
},
"prepaidOperationType": {
"enum": [
"topup",
"drawdown",
null
],
"type": "string",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe type of this charge. It is either a prepayment (topup) charge or a drawdown charge. \n"
},
"prepaidTotalQuantity": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"processedThroughDate": {
"type": "string",
"format": "date",
"description": " The date until when charges have been processed. When billing in arrears, such as usage, this field value is the the same as the `ChargedThroughDate` value. This date is the earliest date when a charge can be amended.\n**Character limit**: 29 **Values**: automatically generated "
},
"rolloverPeriodLength": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period length of the rollover fund.\n"
},
"productRatePlanCharge": {
"$ref": "#/components/schemas/NestedPrpcOnExpand"
},
"specificBillingPeriod": {
"type": "integer",
"format": "int64",
"description": "Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to `Specific Months` or `Specific Weeks`.\n**Character limit**: 5 **Values**: inherited from `ProductRatePlanCharge.BillingPeriod` **Note:** You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment. "
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"nullable": true,
"description": "The number of months for the list price base of the charge. This field is required if you set the value of the `ListPriceBase` field to `Per Specific Months`.\n\n**Notes**: \n - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.\n"
},
"billingPeriodAlignment": {
"type": "string",
"description": "Aligns charges within the same subscription if multiple charges\\\n\\ begin on different dates.\n\n**Values**: inherited from `ProductRatePlanCharge.BillingPeriodAlignment` \n"
},
"revRecTriggerCondition": {
"type": "string",
"description": " Specifies when revenue recognition begins.\n\n**Character limit**: 22\n\n**Values**: inherited from `ProductRatePlanCharge.RevRecTriggerCondition` or one of the following:\n\n- `ContractEffectiveDate`\n\n- `ServiceActivationDate`\n\n- `CustomerAcceptanceDate`\n\nNote: Unless overridden, this value changes if `ProductRatePlanCharge.RevRecTriggerCondition` is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.RevRecTriggerCondition` is updated. "
},
"priceIncreasePercentage": {
"type": "number",
"format": "double",
"description": " Specifies the percentage to increase or decrease the price of renewed subscriptions.\n**Character limit**: 16 **Values**: a decimal value between -100 and 100 "
},
"productRatePlanChargeId": {
"type": "string",
"description": "The unique identifier of the product rate plan charge associated with this product rate plan charge.\n"
},
"overageCalculationOption": {
"type": "string",
"description": "Determines when to calculate overage charges. If the value of the SmoothingMode field is null (not specified and not inherited from ProductRatePlanCharge.SmoothingMode), the value of this field is ignored. **Character limit**: 20 **Values**: inherited from `ProductRatePlanCharge.OverageCalculationOption` "
},
"productChargeDefinitionId": {
"type": "string",
"description": "The unique ID of the product charge definition.\n"
},
"priceUpsellQuantityStacked": {
"type": "boolean"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": " Specifies the Revenue Recognition Rule that you want the Rate Plan Charge to use. This field can be updated when **Status** is `Draft`. By default, the Revenue Recognition Rule is inherited from the Product Rate Plan Charge. For Amend calls, you can use this field only for NewProduct amendments. For Update calls, you can use this field only to update subscriptions in draft status. Note that if you use this field to specify a Revenue Recognition Rule for the Rate Plan Charge, the rule will remain as specified even if you later change the rule used by the corresponding Product Rate Plan Charge.\n\n**Character limit**: n/a\n\n**Values**: inherited from `ProductRatePlanCharge.RevenueRecognitionRuleName` or the name of an active Revenue Recognition Rule\n\n**Note**: Unless overridden, this value changes if `ProductRatePlanCharge.RevenueRecognitionRuleName` is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.RevenueRecognitionRuleName` is updated. "
},
"applyToBillingPeriodPartially": {
"type": "boolean",
"description": "Allow the discount duration to be aligned with the billing period partially.\n\n**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.\n"
},
"overageUnusedUnitsCreditOption": {
"type": "string",
"description": " Determines whether to credit the customer with unused units of usage.\n**Character limit**: 20 **Values**: inherited from `ProductRatePlanCharge.OverageUnusedUnitsCreditOption` "
},
"deferredRevenueAccountingCodeId": {
"type": "string",
"description": "ID of the deferredRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> and <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a> features are enabled.\n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "ID of the accountReceivableAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a>, <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a>, and <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Get_started_with_Invoice_Settlement/AA_Overview_of_Invoice_Settlement\" target=\"_blank\">Invoice Settlement</a> features are enabled.\n"
},
"recognizedRevenueAccountingCodeId": {
"type": "string",
"description": "ID of the recognizedRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> and <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a> features are enabled.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\nIf both the following features in <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing\" target=\"_blank\">Advanced Consumption Billing</a> are enabled in your tenant, you must ensure the `excludeItemBillingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the `excludeItemBookingFromRevenueAccounting` field in an Create Subscription or Add Product order action is set to `false`, you must also set the `excludeItemBillingFromRevenueAccounting` field in this order action to `false`.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charges from revenue accounting.\n\nIf both the following features in <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing\" target=\"_blank\">Advanced Consumption Billing</a> are enabled in your tenant, you must ensure the `excludeItemBookingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
}
}
}
ExpandedRatingResult
{
"type": "object",
"title": "QueryRatingResultResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the rating result.\n"
},
"amount": {
"type": "number",
"description": "The amount of the charge.\n"
},
"status": {
"type": "string",
"description": "The status of the rating result.\n"
},
"account": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"quantity": {
"type": "number",
"description": "The quantity of the charge.\n"
},
"accountId": {
"type": "string",
"description": "The unique identifier of the customer account associated with the rating result.\n"
},
"isPartial": {
"type": "boolean",
"description": "Indicates whether the rating result is partial.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the rating result.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the rating result was created in the Zuora\nsystem, in the `yyyy-mm-dd hh:mm:ss` format.\n"
},
"invoiceItem": {
"$ref": "#/components/schemas/NestedInvoiceItemOnExpand"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the rating result.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the rating result was last updated, in the `yyyy-mm-dd hh:mm:ss` format.\n"
},
"subscription": {
"$ref": "#/components/schemas/NestedSubscriptionOnExpand"
},
"invoiceItemId": {
"type": "string",
"description": "The unique identifier of the invoice item associated with the rating result.\n"
},
"ratePlanCharge": {
"$ref": "#/components/schemas/NestedRatePlanChargeOnExpand"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The end date of the service period for the rating result.\n"
},
"subscriptionId": {
"type": "string",
"description": "The unique identifier of the subscription associated with the rating result.\n"
},
"billingCycleDay": {
"type": "integer",
"format": "int32",
"description": "The day of the month on which the billing cycle starts.\n"
},
"ratePlanChargeId": {
"type": "string",
"description": "The unique identifier of the rate plan charge associated with the rating result.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The start date of the service period for the rating result.\n"
},
"actualPeriodEndDate": {
"type": "string",
"format": "date",
"description": "The end date of the actual period for the rating result.\n"
},
"chargeSegmentNumber": {
"type": "integer",
"format": "int32",
"description": "Rate plan charge number.\n"
},
"actualPeriodStartDate": {
"type": "string",
"format": "date",
"description": "The start date of the actual period for the rating result.\n"
}
}
}
ExpandedRefund
{
"type": "object",
"title": "QueryRefundResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the refund.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the refund. \n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the refund.\n"
},
"status": {
"enum": [
"Processed",
"Canceled",
"Error",
"Processing"
],
"type": "string",
"description": "The status of the refund. \n"
},
"account": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"comment": {
"type": "string",
"description": "Comments about the refund.\n"
},
"gateway": {
"type": "string",
"description": "The gateway that processed the original payment. A gateway is an online service provider that connects an online shopping cart to a payment processor.\nZuora uses this same gateway for the corresponding refund. \nIf this payment gateway is no longer active, then the electronic refund fails. \n"
},
"currency": {
"type": "string",
"description": "The currency of the refund.\n"
},
"payoutId": {
"type": "string",
"description": "The payout ID of the refund from the gateway side.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment or credit memo.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways.\n"
},
"methodType": {
"enum": [
"ACH",
"Cash",
"Check",
"CreditCard",
"PayPal",
"WireTransfer",
"DebitCard",
"CreditCardReferenceTransaction",
"BankTransfer",
"Other"
],
"type": "string",
"description": "How an external refund was issued to a customer. \n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction.\n"
},
"refundDate": {
"type": "string",
"format": "date",
"description": "The date when the refund takes effect, in `yyyy-mm-dd` format. For example, 2017-03-01.\n"
},
"sourceType": {
"enum": [
"Payment",
"CreditBalance"
],
"type": "string",
"description": "Specifies whether the refund is a refund payment or a credit balance. \n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the refund.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was created.\n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was submitted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the refund.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was last updated.\n"
},
"gatewayState": {
"enum": [
"MarkedForSubmission",
"Submitted",
"Settled",
"NotSubmitted",
"FailedToSettle"
],
"type": "string",
"description": "The status of the refund in the gateway. \n"
},
"refundNumber": {
"type": "string",
"description": "The number of the refund.\n"
},
"paymentMethod": {
"$ref": "#/components/schemas/NestedPaymentMethodOnExpand"
},
"accountingCode": {
"type": "string",
"description": "The accounting code that maps to this refund transaction in your accounting\nsystem.\n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the refund. This\nmessage is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the refund.\n"
},
"refundApplications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedRefundApplicationOnExpand"
}
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the refund. This code\nis gateway-dependent.\n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways.\n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"refundTransactionTime": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot which is a copy of the particular payment method used in a transaction.\n"
},
"secondRefundReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"associatedTransactionNumber": {
"type": "string",
"description": "The number of the associated transactions, such as payments.\n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
}
ExpandedRefundApplication
{
"type": "object",
"title": "QueryRefundApplicationResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the refund application.\n"
},
"refund": {
"$ref": "#/components/schemas/NestedRefundOnExpand"
},
"payment": {
"$ref": "#/components/schemas/NestedPaymentOnExpand"
},
"refundId": {
"type": "string",
"description": "The unique identifier of the refund associated with the refund application.\n"
},
"accountId": {
"type": "string"
},
"invoiceId": {
"type": "string",
"description": "The unique identifier of the invoice to which the associated payment was applied.\n"
},
"paymentId": {
"type": "string",
"description": "The unique identifier of the payment associated with the refund application.\n"
},
"applyAmount": {
"type": "number",
"format": "double",
"description": "The total amount of the refund to be applied.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the refund application.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund application was created.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the refund application.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund application was last updated.\n"
},
"creditMemoId": {
"type": "string",
"description": "The unique identifier of the credit memo to which the associated payment was applied.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the refund application becomes effective.\n"
},
"journalEntryId": {
"type": "string",
"description": "The ID of the journal entry that corresponds to this transaction.\n"
},
"applicationGroupId": {
"type": "string",
"description": "The ID of the application group to which this payment application belongs.\n"
},
"cashAccountingCodeId": {
"type": "string",
"description": "The accounting code for cash payments.\n"
},
"refundApplicationItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedRefundApplicationItemOnExpand"
}
},
"onAccountAccountingCodeId": {
"type": "string",
"description": "The accounting code that maps to an on account in your accounting\nsystem.\n"
},
"unappliedPaymentAccountingCodeId": {
"type": "string",
"description": "The accounting code for the unapplied payment.\n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "The accountReceivableAccountingCode of a standalone charge.\n"
}
}
}
ExpandedRefundApplicationItem
{
"type": "object",
"title": "QueryRefundApplicationItemResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the refund application item.\n"
},
"amount": {
"type": "number",
"description": "The amount of the refund application item.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the refund application item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund application item was created.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the refund application item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund application item was last updated.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the refund application item becomes effective.\n"
},
"journalEntryId": {
"type": "string",
"description": "The ID of the journal entry that corresponds to this transaction.\n"
},
"creditMemoItemId": {
"type": "string",
"description": "The unique identifier of the credit memo item to which the refund application item is applied.\n"
},
"refundApplication": {
"$ref": "#/components/schemas/NestedRefundApplicationOnExpand"
},
"applicationGroupId": {
"type": "string",
"description": "The ID of the application group to which this refund application belongs.\n"
},
"refundApplicationId": {
"type": "string",
"description": "The ID of the refund application to which this refund application item belongs.\n"
},
"cashAccountingCodeId": {
"type": "string",
"description": "The accounting code for cash payments.\n"
},
"creditTaxationItemId": {
"type": "string",
"description": "The unique identifier of the credit taxation item to which the refund application item is applied.\n"
},
"onAccountAccountingCodeId": {
"type": "string",
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"unappliedPaymentAccountingCodeId": {
"type": "string",
"description": "The accounting code for the unapplied payment.\n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "The Account Receivable accounting code of a standalone charge.\n"
}
}
}
ExpandedSubscription
{
"type": "object",
"title": "QuerySubscriptionResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the subscription.\n"
},
"cMRR": {
"type": "number",
"description": "Monthly recurring revenue of the subscription.\n"
},
"name": {
"type": "string",
"description": "The name of the subscription.\n"
},
"notes": {
"type": "string",
"maxLength": 65535,
"description": "Additional information about the subscription.\n"
},
"rampId": {
"type": "string",
"description": "The ID of the ramp object associated with the subscription.\n\n**Note**: This field is available only if you have the <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Ramp\"\ntarget=\"_blank\">Ramp</a> feature enabled.\n"
},
"status": {
"enum": [
"Draft",
"Pending Activation",
"Pending Acceptance",
"Active",
"Cancelled",
"Suspended"
],
"type": "string",
"description": "Subscription status.\n"
},
"account": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"version": {
"type": "integer",
"format": "int64",
"description": "This is the subscription version automatically generated by Zuora Billing. Each order or amendment creates a new version of the subscription, which incorporates the changes made in the order or amendment."
},
"currency": {
"type": "string",
"description": "The currency of the subscription.\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currencies</a> feature enabled.\n"
},
"revision": {
"type": "string",
"description": "An auto-generated decimal value uniquely tagged with a subscription.\nThe value always contains one decimal place, for example, the revision\nof a new subscription is 1.0. If a further version of the subscription\nis created, the revision value will be increased by 1. Also, the\nrevision value is always incremental regardless of deletion of\nsubscription versions.\n"
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN"
],
"type": "string",
"description": "The type of the subscription term.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with this subscription."
},
"autoRenew": {
"type": "boolean",
"default": false,
"description": "If `true`, the subscription automatically renews at the end of the\nterm. \n"
},
"ratePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedRatePlanOnExpand"
}
},
"originalId": {
"type": "string",
"description": "The original rate plan charge ID. Only available for update\nsubscription.\n"
},
"prepayment": {
"type": "boolean",
"description": "Whether the subscription is prepaid.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the subscription.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the subscription was created in the Zuora\nsystem, in the `yyyy-mm-dd hh:mm:ss` format.\n"
},
"currentTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the current subscription term.\n"
},
"initialTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the initial subscription term.\n"
},
"paymentTerm": {
"type": "string",
"description": "Name of the payment term associated with the account. For example,\n\"Net 30\". The payment term determines the due dates of invoices.\n"
},
"renewalTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the subscription renewal term.\n"
},
"termEndDate": {
"type": "string",
"format": "date",
"description": "Date the subscription term ends. If the subscription is evergreen,\nthis is null or is the cancellation date (if one has been set).\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the subscription.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the subscription was last updated, in the `yyyy-mm-dd hh:mm:ss` format.\n"
},
"cancelReason": {
"type": "string",
"description": "The reason for a subscription cancellation copied from the\n`changeReason` field of a Cancel Subscription order action. \n\nThis field contains valid value only if a subscription is cancelled\nthrough the Orders UI or API. Otherwise, the value for this field will\nalways be `null`.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedInvoiceItemOnExpand"
}
},
"invoiceOwner": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"billToContact": {
"$ref": "#/components/schemas/ExpandedContact"
},
"cancelledDate": {
"type": "string",
"format": "date",
"description": "The date on which the subscription was canceled.\n"
},
"quoteType__QT": {
"type": "string",
"maxLength": 32,
"description": "The Quote type that represents the subscription lifecycle stage such as\nNew, Amendment, Renew or Cancel. This field is used in Zuora data sources\nto report on Subscription metrics. If the subscription originated from\nZuora Quotes, the value is populated with the value from Zuora Quotes.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"termStartDate": {
"type": "string",
"format": "date",
"description": "Date the subscription term begins. If this is a renewal subscription,\nthis date is different from the subscription start date.\n"
},
"invoiceOwnerId": {
"type": "string",
"description": "The account ID that owns the invoices associated with the subscription. \n"
},
"renewalSetting": {
"enum": [
"RENEW_WITH_SPECIFIC_TERM",
"RENEW_TO_EVERGREEN"
],
"type": "string",
"default": "RENEW_WITH_SPECIFIC_TERM",
"description": "Specifies whether a termed subscription will remain `TERMED` or change to `EVERGREEN` when it is renewed. \n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact for the subscription.\n"
},
"isLatestVersion": {
"type": "boolean",
"description": "If `true`, the current subscription object is the latest version.\n"
},
"lastBookingDate": {
"type": "string",
"format": "date",
"description": "The last booking date of the subscription object. This field is\nwritable only when the subscription is newly created as a first\nversion subscription. You can override the date value when creating a\nsubscription through the Subscribe and Amend API or the subscription\ncreation UI (non-Orders). Otherwise, the default value `today` is set\nper the user's timezone. The value of this field is as follows:\n\n* For a new subscription created by the [Subscribe and Amend\nAPIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate),\nthis field has the value of the subscription creation date.\n\n* For a subscription changed by an amendment, this field has the value\nof the amendment booking date.\n\n* For a subscription created or changed by an order, this field has\nthe value of the order date. \n"
},
"quoteNumber__QT": {
"type": "string",
"maxLength": 32,
"description": "The unique identifier of the Quote. This field is used in Zuora data\nsources to report on Subscription metrics. If the subscription originated\nfrom Zuora Quotes, the value is populated with the value from Zuora\nQuotes.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact for the subscription.\n"
},
"creatorAccountId": {
"type": "string",
"description": "The ID of the account that created the subscription. This field is\nautomatically populated with the ID of the account that creates the\nsubscription.\n"
},
"invoiceScheduleId": {
"type": "string",
"description": "The ID of the invoice schedule associated with the subscription.\n\n\nIf multiple invoice schedules are created for different terms of a\nsubscription, this field stores the latest invoice schedule.\n\n\n**Note**: This field is available only if you have the <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\"\ntarget=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"isInvoiceSeparate": {
"type": "boolean",
"default": false,
"description": "Determines if the subscription is invoiced separately. \nIf `true`, then all charges for this subscription are collected into the subscription's own invoice.\n"
},
"cpqBundleJsonId__QT": {
"type": "string",
"maxLength": 32,
"description": "The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.\n"
},
"externallyManagedBy": {
"enum": [
"Amazon",
"Apple",
"Google",
"Roku"
],
"type": "string",
"description": "An enum field on the Subscription object to indicate the name of a\nthird-party store. This field is used to represent subscriptions created\nthrough third-party stores.\n"
},
"opportunityName__QT": {
"type": "string",
"maxLength": 100,
"description": "The unique identifier of the Opportunity. This field is used in Zuora data\nsources to report on Subscription metrics. If the subscription originated\nfrom Zuora Quotes, the value is populated with the value from Zuora\nQuotes.\n"
},
"originalCreatedDate": {
"type": "string",
"description": "The date when the subscription was originally created. \nThis value is the same as the `createdDate` value until the subscription is amended.\n"
},
"subscriptionEndDate": {
"type": "string",
"format": "date",
"description": "The date when the subscription term ends, where the subscription ends\nat midnight the day before.\n\nFor example, if the `subscriptionEndDate` is 12/31/2016, the\nsubscriptions ends at midnight (00:00:00 hours) on 12/30/2016.\n\nThis date is the same as the term end date or the cancelation date, as\nappropriate.\n"
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the subscription is activated, in the `yyyy-mm-dd` format.\n\n\nYou must specify a Service Activation date if the Customer Acceptance\ndate is set. If the Customer Acceptance date is not set, the value of\nthe `serviceActivationDate` field defaults to be the Contract\nEffective Date.\n\n\nThe billing trigger dates must follow this rule:\n\n\ncontractEffectiveDate <= serviceActivationDate <=\ncontractAcceptanceDate\n"
},
"creatorInvoiceOwnerId": {
"type": "string",
"description": "The account ID that owns the invoices associated with the subscription or the amended subscription.\n"
},
"currentTermPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"default": "Month",
"description": "The period type for the current subscription term.\n"
},
"initialTermPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"default": "Month",
"description": "The period type for the first subscription term.\n"
},
"quoteBusinessType__QT": {
"type": "string",
"maxLength": 32,
"description": "The specific identifier for the type of business transaction the Quote\nrepresents such as New, Upsell, Downsell, Renewal or Churn. This field is\nused in Zuora data sources to report on Subscription metrics. If the\nsubscription originated from Zuora Quotes, the value is populated with the\nvalue from Zuora Quotes.\n"
},
"renewalTermPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"default": "Month",
"description": "The period type for the subscription renewal term.\n"
},
"serviceActivationDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been activated and access has been provided to the customer, in the `yyyy-mm-dd` format.\n"
},
"subscriptionStartDate": {
"type": "string",
"format": "date",
"description": "Date the subscription becomes effective.\n"
},
"contractAcceptanceDate": {
"type": "string",
"format": "date",
"description": "The date when the customer accepts the contract, in the `yyyy-mm-dd` format.\n\nIf this field is not set:\n\n- If the `serviceActivationDate` field is not set, the value of this\nfield is set to be the contract effective date.\n\n- If the `serviceActivationDate` field is set, the value of this field\nis set to be the service activation date.\n\n\nThe billing trigger dates must follow this rule:\n\ncontractEffectiveDate <= serviceActivationDate <=\ncontractAcceptanceDate\n"
},
"previousSubscriptionId": {
"type": "string",
"description": "The ID of the previous subscription. This field is only available if\nthe subscription is a renewal subscription.\n"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot.\n"
},
"opportunityCloseDate__QT": {
"type": "string",
"format": "date"
},
"subscriptionVersionAmendmentId": {
"type": "string",
"description": "The ID of the amendment made to this subscription version.\n"
}
}
}
ExpandedTaxationItem
{
"type": "object",
"title": "QueryTaxationItemResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the taxation item.\n"
},
"name": {
"type": "string",
"description": "The name of the taxation item. \n"
},
"balance": {
"type": "number"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a\nspecific billing document.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date when the tax is applied to the billing document.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive"
],
"type": "string",
"description": "The mode of the tax.\n"
},
"taxRate": {
"type": "number",
"format": "double",
"description": "The tax rate applied to the billing document.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of the tax applied to the billing document.\n"
},
"taxRuleId": {
"type": "string",
"description": "The unique identifier of the tax rule.\n"
},
"countryCode": {
"type": "string",
"description": "The code of country to which the taxation item.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the taxation item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the taxation item was created in the Zuora\nsystem, in the `yyyy-mm-dd hh:mm:ss` format.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate applied to the billing document.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the taxation item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the taxation item was last updated, in the `yyyy-mm-dd hh:mm:ss` format. \n"
},
"creditAmount": {
"type": "number",
"format": "double",
"description": "The amount of credit memos applied to the taxation item. \n"
},
"customerCode": {
"type": "string"
},
"exemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically\na state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field. \n"
},
"invoiceItemId": {
"type": "string",
"description": "The unique identifier of the invoice item to which the taxation item belongs.\n"
},
"paymentAmount": {
"type": "number",
"format": "double",
"description": "The amount of payment applied to the invoice or debit memo. \n"
},
"accountingCode": {
"type": "string",
"description": "The accounting code that maps to the taxation item in your accounting system.\n"
},
"journalEntryId": {
"type": "string",
"description": "The ID of the journal entry that corresponds to this transaction.\n"
},
"taxDescription": {
"type": "string",
"description": "The description of the tax.\n"
},
"exemptCertificate": {
"type": "string",
"description": "The tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"sellerRegistration": {
"type": "string"
},
"taxAmountUnrounded": {
"type": "number",
"description": "The amount of the tax applied to the billing document before rounding.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
},
"taxableItemSnapshotId": {
"type": "string",
"description": "The unique identifier of the taxable item snapshot.\n"
},
"salesTaxPayableAccountingCodeId": {
"type": "string",
"description": "The accounting code for Sales Tax Payable.\n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "The accounting code for Account Receivable.\n"
}
}
}
ExpandedUsage
{
"type": "object",
"title": "QueryUsageResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the usage.\n"
},
"uOM": {
"type": "string",
"description": "The units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**.\n"
},
"fileId": {
"type": "string",
"description": "File ID of the uploaded usage records file. You can use this file ID with [Get files](https://developer.zuora.com/api-references/api/operation/GET_Files) to download the file.\n"
},
"account": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"fileName": {
"type": "string",
"description": "The name of the import file when the usage record is imported from the file.\n"
},
"importId": {
"type": "string",
"description": "The unique identifier of the import.\n"
},
"quantity": {
"type": "number",
"description": "Number of units used.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the usage.\n"
},
"rbeStatus": {
"enum": [
"Importing",
"Pending",
"Processed"
],
"type": "string",
"description": "Indicates if the rating and billing engine (RBE) processed usage data for an invoice.\n"
},
"uniqueKey": {
"type": "string",
"description": "a customer-defined specific identifier of a usage record.\n\n**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled. See [Upload usage record with unique\nkey](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Prepaid_balance_transactions#Upload_usage_record_with_unique_key)\nfor more information.\n"
},
"sourceType": {
"enum": [
"API",
"Import"
],
"type": "string",
"description": "Indicates if the usage records were imported from the web-based UI or the API.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the usage.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the usage was created.\n"
},
"description": {
"type": "string",
"description": "A description of the usage record.\n"
},
"endDateTime": {
"type": "string",
"format": "date-time",
"description": "End date of the time period in which usage is tracked. Zuora uses\nthis field value to determine the usage date.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the usage.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the usage was last updated.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account associated with the usage.\n"
},
"startDateTime": {
"type": "string",
"format": "date-time",
"description": "Start date of the time period in which usage is tracked. Zuora uses\nthis field value to determine the usage date.\n"
},
"subscriptionId": {
"type": "string",
"description": "The original ID of the subscription that contains the fees related to the usage data.\n"
},
"ratePlanChargeId": {
"type": "string",
"description": "ID of the rate plan charge that pays for this usage.\n"
},
"submissionDateTime": {
"type": "string",
"format": "date-time",
"description": "The date and time when the usage was submitted.\n"
}
}
}
ExpandedValidityPeriodSummary
{
"type": "object",
"title": "QueryValidityPeriodSummaryResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the validity period summary.\n"
},
"uom": {
"type": "string",
"description": "The UOM of the validity period.\n"
},
"account": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date of the validity period.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account to which the prepaid balance belongs.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the validity period.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the validity period summary.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the validity period summary was created.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the validity period summary.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the validity period summary was last updated.\n"
},
"totalBalance": {
"type": "number",
"description": "The total prepaid balance for the current validity period.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the account to which the prepaid balance belongs.\n"
},
"prepaidBalance": {
"$ref": "#/components/schemas/NestedPrepaidBalanceOnExpand"
},
"prepaidBalanceId": {
"type": "string",
"description": "The unique identifier of the prepaid balance.\n"
},
"remainingBalance": {
"type": "number",
"description": "The remaining prepaid balance for the current validity period.\n"
},
"totalBilledAmount": {
"type": "number"
},
"overageRatedAmount": {
"type": "number",
"format": "double",
"description": "The overage rated amount for the validity period.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "The number of the subscription the validity period belongs to.\n"
},
"billedBalanceAmount": {
"type": "number"
},
"overageRatedQuantity": {
"type": "number",
"format": "double",
"description": "The overage rated quantity for the validity period.\n"
}
}
}
ExportWorkflowVersionResponse
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Task"
}
},
"linkages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Linkage"
}
},
"workflow": {
"$ref": "#/components/schemas/Workflow"
}
}
}
FieldsAdditionalProperties
{
"type": "object",
"title": "relationshipFieldMapping",
"description": "Field mappings in the form of `<this-object-field-name>`: `<other-object-field-name>`.\n",
"additionalProperties": {
"type": "string"
}
}
FieldsAdditionalPropertiesForPostDefinition
{
"type": "object",
"title": "relationshipFieldMapping",
"description": "Field mappings in the form of `<this-object-field-name>`: `<other-object-field-name>`. Usually the `<other-object-field-name>` can only be the `Id` field of the related object. Two exceptions are Subscription Name and Rate Plan Charge Number as both of them are unique.\n",
"additionalProperties": {
"type": "string"
}
}
FilterRuleParameterDefinition
{
"type": "object",
"title": "parameter",
"properties": {
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "The option values of the parameter.\n"
},
"valueType": {
"enum": [
"STRING",
"BYTE",
"SHORT",
"CHARACTER",
"INTEGER",
"LONG",
"FLOAT",
"DOUBLE",
"BOOLEAN",
"BIG_INTEGER",
"BIG_DECIMAL",
"LOCAL_DATE",
"LOCAL_DATE_TIME",
"TIMESTAMP",
"BYTE_ARRAY",
"SHORT_ARRAY",
"CHARACTER_ARRAY",
"INTEGER_ARRAY",
"FLOAT_ARRAY",
"DOUBLE_ARRAY",
"BOOLEAN_ARRAY",
"STRING_ARRAY",
"BIG_INTEGER_ARRAY",
"BIG_DECIMAL_ARRAY",
"LOCAL_DATE_ARRAY",
"LOCAL_DATE_TIME_ARRAY",
"TIMESTAMP_ARRAY"
],
"type": "string",
"description": "The type of the value.\n"
},
"description": {
"type": "string",
"maxLength": 255
},
"displayName": {
"type": "string",
"maxLength": 255,
"description": "The display name of the parameter.\n"
}
},
"description": "Definition of a filter rule parameter.\n"
}
FilterRuleParameterDefinitions
{
"type": "object",
"title": "parameters",
"description": "The parameters of the filter rule and their name must match those in the filter rule. And all parameters must be defined in the event type payload. The name of parameters can't be duplicate. The following reserved keywords should not be used as a parameter name: `AttachmentList`, `RecipientList`, `RecipientType`, `Exceptions`, `OCP_OBJECT_TYPE`, `OCP_OBJECT_ID`, `OCP_TRIGGER_BY`\n",
"additionalProperties": {
"$ref": "#/components/schemas/FilterRuleParameterDefinition"
}
}
FilterRuleParameterValues
{
"type": "object",
"title": "filterRuleParams",
"description": "The parameter values used to configure the filter rule.\n",
"additionalProperties": {
"type": "string",
"description": "The following reserved key words should not be used as a parameter name: `AttachmentList`, `RecipientList`, `RecipientType`, `Exceptions`, `OCP_OBJECT_TYPE`, `OCP_OBJECT_ID`, `OCP_TRIGGER_BY`. `Include.Attachment` is a special boolean parameter. By specifying this parameter, you can tell a notification whose event type is based on Invoice to include attachments while sending emails.\n"
}
}
FulfillmentCommon
{
"type": "object",
"title": "Fulfillment",
"properties": {
"state": {
"enum": [
"Executing",
"Booked",
"SentToBilling",
"Complete",
"Cancelled"
],
"type": "string",
"description": "The state of the Fulfillment. See [State transitions for an order, order line item, and fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States) for more information.\n"
},
"carrier": {
"type": "string",
"description": "The carrier of the Fulfillment. The available values can be configured in **Billing Settings** > **Fulfillment Settings** through Zuora UI.\n"
},
"quantity": {
"type": "number",
"description": "The quantity of the Fulfillment.\n"
},
"externalId": {
"type": "string",
"description": "The external id of the Fulfillment.\n"
},
"description": {
"type": "string",
"description": "The description of the Fulfillment.\n"
},
"customFields": {
"$ref": "#/components/schemas/FulfillmentCustomFields"
},
"billTargetDate": {
"type": "string",
"format": "date",
"description": "The target date for the Fulfillment to be picked up by bill run for billing.\n"
},
"trackingNumber": {
"type": "string",
"description": "The tracking number of the Fulfillment.\n"
},
"fulfillmentDate": {
"type": "string",
"format": "date",
"description": "The date of the Fulfillment.\n"
},
"fulfillmentType": {
"enum": [
"Delivery",
"Return"
],
"type": "string",
"description": "The type of the Fulfillment. \n"
},
"orderLineItemId": {
"type": "string",
"format": "UUID",
"description": "The reference id of the related Order Line Item.\n"
},
"fulfillmentSystem": {
"type": "string",
"description": "The fulfillment system of the Fulfillment. The available values can be configured in **Billing Settings** > **Fulfillment Settings** through Zuora UI.\n"
},
"fulfillmentLocation": {
"type": "string",
"description": "The fulfillment location of the Fulfillment. The available values can be configured in **Billing Settings** > **Fulfillment Settings** through Zuora UI.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude Fulfillment related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude Fulfillment from revenue accounting.\n\n**Note**: This field is only available if you have the [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
}
}
}
FulfillmentCustomFields
{
"type": "object",
"title": "FulfillmentCustomFields",
"description": "Container for custom fields of a Fulfillment object.\n",
"additionalProperties": {
"description": "Custom fields of the Fulfillment object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
FulfillmentGet
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "UUID",
"description": "The sytem generated Id.\n"
},
"fulfillmentNumber": {
"type": "string",
"description": "The sytem generated number for the Fulfillment.\n"
}
}
},
{
"$ref": "#/components/schemas/FulfillmentCommon"
}
]
}
FulfillmentItemCommon
{
"type": "object",
"title": "FulfillmentItem",
"properties": {
"description": {
"type": "string",
"description": "The description of the Fulfillment Item.\n"
},
"customFields": {
"$ref": "#/components/schemas/FulfillmentItemCustomFields"
},
"itemIdentifier": {
"type": "string",
"description": "The external identifier of the Fulfillment Item.\n"
}
}
}
FulfillmentItemCustomFields
{
"type": "object",
"title": "FulfillmentItemCustomFields",
"description": "Container for custom fields of a Fulfillment Item object.\n",
"additionalProperties": {
"description": "Custom fields of the Fulfillment Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
FulfillmentItemGet
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "UUID",
"description": "The sytem generated Id.\n"
},
"fulfillmentId": {
"type": "string",
"format": "UUID",
"description": "The reference id of the related Fulfillment.\n"
}
}
},
{
"$ref": "#/components/schemas/FulfillmentItemCommon"
}
]
}
FulfillmentItemPost
{
"allOf": [
{
"type": "object",
"properties": {
"fulfillmentNumber": {
"type": "string",
"description": "The reference of the related Fulfillment.\n"
}
}
},
{
"$ref": "#/components/schemas/FulfillmentItemCommon"
}
]
}
FulfillmentPost
{
"allOf": [
{
"type": "object",
"properties": {
"orderLineItemId": {
"type": "string",
"format": "UUID",
"description": "The reference id of the related Order Line Item.\n"
}
}
},
{
"$ref": "#/components/schemas/FulfillmentCommon"
},
{
"type": "object",
"properties": {
"fulfillmentItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FulfillmentItemCommon"
}
}
}
}
]
}
GETAPaymentGatwayResponse
{
"type": "object",
"title": "paymentgateways",
"properties": {
"id": {
"type": "string",
"description": "The ID of the payment gateway."
},
"name": {
"type": "string",
"description": "The name of the payment gateway."
},
"type": {
"type": "string",
"description": "The type of the payment gateway"
},
"isActive": {
"type": "boolean",
"description": "Specifies if this payment gateway is in active status."
},
"isDefault": {
"type": "boolean",
"description": "Specifies if this is the default payment gateway to process payments for your customer accounts."
}
}
}
GETARPaymentType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the payment.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the payment. For example, P-00000001.\n"
},
"status": {
"enum": [
"Draft",
"Processing",
"Processed",
"Error",
"Canceled",
"Posted"
],
"type": "string",
"description": "The status of the payment.\n"
},
"comment": {
"type": "string",
"description": "Comments about the payment.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"currency": {
"type": "string",
"description": "When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI.\n\nWhen Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.\n"
},
"payoutId": {
"type": "string",
"description": "The payout ID of the payment from the gateway side.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account that the payment is for.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the payment.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways.\n"
},
"prepayment": {
"type": "boolean",
"description": "Indicates whether the payment is used as a reserved payment. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.\n"
},
"standalone": {
"type": "boolean",
"default": false,
"description": "This field is only available if the support for standalone payment is enabled. This field is not available for transferring, applying, or unapplying a payment.\n\nThe value `true` indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred.\n\nThe value `false` indicates this is an ordinary payment that is created, processed, and settled in Zuora.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the payment.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was submitted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the payment.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"gatewayState": {
"enum": [
"MarkedForSubmission",
"Submitted",
"Settled",
"NotSubmitted",
"FailedToSettle"
],
"type": "string",
"description": "The status of the payment in the gateway; use for reconciliation.\n"
},
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the payment that is refunded.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account that the payment is for.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the payment.\n"
},
"effectiveDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment takes effect, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"gatewayOrderId": {
"type": "string",
"description": "A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead.\n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the payment. This message is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the payment.\n"
},
"unappliedAmount": {
"type": "number",
"format": "double",
"description": "The unapplied amount of the payment.\n"
},
"authTransactionId": {
"type": "string",
"description": "The authorization transaction ID from the payment gateway.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"bankAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to a bank account in your accounting system.\n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"description": "The accounting code for the unapplied payment.\n"
},
"unappliedPaymentAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the unapplied payment.\n"
}
},
"description": "Container for the finance information related to the payment.\n"
},
"paymentScheduleKey": {
"type": "string",
"description": "The unique ID or the number of the payment schedule that is linked to the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information."
},
"creditBalanceAmount": {
"type": "number",
"format": "double",
"description": "The amount that the payment transfers to the credit balance. The value is not `0` only for those payments that come from legacy payment operations performed without the Invoice Settlement feature.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the payment. This code is gateway-dependent.\n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"paymentGatewayNumber": {
"type": "string",
"description": "The natural key for the payment gateway.\n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a payment was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n"
},
"bankIdentificationNumber": {
"type": "string",
"description": "The first six or eight digits of the credit card or debit card used for the payment, when applicable.\n"
},
"secondPaymentReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentObjectNSFields"
},
{
"$ref": "#/components/schemas/PaymentObjectCustomFields"
}
]
}
GETARPaymentTypeWithPaymentOption
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the payment.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the payment. For example, P-00000001.\n"
},
"status": {
"enum": [
"Draft",
"Processing",
"Processed",
"Error",
"Canceled",
"Posted",
"Pending"
],
"type": "string",
"description": "The status of the payment.\n\nIf the <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Asynchronous_payment_flow\" target=\"_blank\">Asynchronous Payment Statuses</a> feature is not enabled, possible values are `Draft`, `Processing`, `Processed`, `Error`, `Canceled`, and `Posted`.\n\nIf the Asynchronous Payment Statuses feature is enabled, when the ACH or Bank Transfer payment is created, it is in a `Pending` status upon successful network communication with the gateway. To transition from a `Pending` status to another status, use one of our Gateway Reconciliation options or cancel the payment.\n"
},
"comment": {
"type": "string",
"description": "Comments about the payment.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"currency": {
"type": "string",
"description": "When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI.\n\nWhen Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.\n"
},
"payoutId": {
"type": "string",
"description": "The payout ID of the payment from the gateway side.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account that the payment is for.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the payment.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways.\n"
},
"prepayment": {
"type": "boolean",
"description": "Indicates whether the payment is used as a reserved payment. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.\n"
},
"standalone": {
"type": "boolean",
"default": false,
"description": "This field is only available if the support for standalone payment is enabled. This field is not available for transferring, applying, or unapplying a payment.\n\nThe value `true` indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred.\n\nThe value `false` indicates this is an ordinary payment that is created, processed, and settled in Zuora.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the payment.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was submitted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the payment.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"gatewayState": {
"enum": [
"MarkedForSubmission",
"Submitted",
"Settled",
"NotSubmitted",
"FailedToSettle"
],
"type": "string",
"description": "The status of the payment in the gateway; use for reconciliation.\n"
},
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the payment that is refunded.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account that the payment is for.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the payment.\n"
},
"effectiveDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment takes effect, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
},
"gatewayOrderId": {
"type": "string",
"description": "A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead.\n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the payment. This message is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the payment.\n"
},
"unappliedAmount": {
"type": "number",
"format": "double",
"description": "The unapplied amount of the payment.\n"
},
"authTransactionId": {
"type": "string",
"description": "The authorization transaction ID from the payment gateway.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"bankAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to a bank account in your accounting system.\n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"description": "The accounting code for the unapplied payment.\n"
},
"unappliedPaymentAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the unapplied payment.\n"
}
},
"description": "Container for the finance information related to the payment.\n"
},
"paymentScheduleKey": {
"type": "string",
"description": "The unique ID or the number of the payment schedule that is linked to the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information."
},
"creditBalanceAmount": {
"type": "number",
"format": "double",
"description": "The amount that the payment transfers to the credit balance. The value is not `0` only for those payments that come from legacy payment operations performed without the Invoice Settlement feature.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the payment. This code is gateway-dependent.\n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"paymentGatewayNumber": {
"type": "string",
"description": "The natural key for the payment gateway.\n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a payment was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n"
},
"bankIdentificationNumber": {
"type": "string",
"description": "The first six or eight digits of the credit card or debit card used for the payment, when applicable.\n"
},
"secondPaymentReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentObjectNSFields"
},
{
"$ref": "#/components/schemas/PaymentObjectCustomFields"
}
]
}
GETARPaymentTypewithSuccess
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the payment. For example, 4028905f5a87c0ff015a87eb6b75007f.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the payment.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the payment. For example, P-00000001.\n"
},
"status": {
"enum": [
"Draft",
"Processing",
"Processed",
"Error",
"Canceled",
"Posted"
],
"type": "string",
"description": "The status of the payment.\n"
},
"comment": {
"type": "string",
"description": "Comments about the payment.\n"
},
"currency": {
"type": "string",
"description": "When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI.\n\nWhen Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.\n"
},
"payoutId": {
"type": "string",
"description": "The payout ID of the payment from the gateway side.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account that the payment is for.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the payment.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways.\n"
},
"prepayment": {
"type": "boolean",
"description": "Indicates whether the payment is used as a reserved payment. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.\n"
},
"standalone": {
"type": "boolean",
"default": false,
"description": "This field is only available if the support for standalone payment is enabled.\n\nThe value `true` indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred.\n\nThe value `false` indicates this is an ordinary payment that is created, processed, and settled in Zuora.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the payment part.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was submitted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the payment.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"gatewayState": {
"enum": [
"MarkedForSubmission",
"Submitted",
"Settled",
"NotSubmitted",
"FailedToSettle"
],
"type": "string",
"description": "The status of the payment in the gateway; use for reconciliation. \n"
},
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the payment that is refunded.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account that the payment is for.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the payment.\n"
},
"effectiveDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment takes effect, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
},
"gatewayOrderId": {
"type": "string",
"description": "A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created.\n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the payment. This message is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the payment.\n"
},
"unappliedAmount": {
"type": "number",
"format": "double",
"description": "The unapplied amount of the payment.\n"
},
"authTransactionId": {
"type": "string",
"description": "The authorization transaction ID from the payment gateway.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"bankAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to a bank account in your accounting system.\n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"description": "The accounting code for the unapplied payment.\n"
},
"unappliedPaymentAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the unapplied payment.\n"
}
},
"description": "Container for the finance information related to the payment.\n"
},
"paymentScheduleKey": {
"type": "string",
"description": "The unique ID or the number of the payment schedule that is linked to the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information."
},
"creditBalanceAmount": {
"type": "number",
"format": "double",
"description": "The amount that the payment transfers to the credit balance. The value is not `0` only for those payments that come from legacy payment operations performed without the Invoice Settlement feature.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the payment. This code is gateway-dependent.\n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"paymentGatewayNumber": {
"type": "string",
"description": "The natural key for the payment gateway.\n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a payment was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n"
},
"bankIdentificationNumber": {
"type": "string",
"description": "The first six or eight digits of the credit card or debit card used for the payment, when applicable.\n"
},
"secondPaymentReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentObjectNSFields"
},
{
"$ref": "#/components/schemas/PaymentObjectCustomFields"
}
],
"title": "payments"
}
GETAccountCurrencyMetricsType
{
"allOf": [
{
"type": "object",
"properties": {
"balance": {
"type": "string",
"description": "The total balance in this currency.\n"
},
"currency": {
"type": "string",
"description": "The currency that metrics are aggregated based on.\n"
},
"contractedMrr": {
"type": "string",
"format": "decimal",
"description": "The future expected Monthly Recurring Revenue (MRR) in this currency, accounting for future upgrades, downgrades, upsells, and cancellations.\n"
},
"totalInvoiceBalance": {
"type": "string",
"format": "decimal",
"description": "The total balance of all posted invoices in this currency.\n"
},
"reservedPaymentAmount": {
"type": "string",
"format": "decimal",
"description": "The reserved payment amount of the customer account in this currency. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown\" target=\"_blank\">Prepaid Cash with Drawdown</a>.\n"
},
"totalDebitMemoBalance": {
"type": "string",
"format": "decimal",
"description": "The total balance of all posted debit memos in this currency.\n\n**Note:** This field is only available if you have <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement\" target=\"_blank\">Invoice Settlement</a> 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 <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amount[…]ment/AC_Invoice_Settlement_migration_checklist_and_guide\" target=\"_blank\">Invoice Settlement Enablement and Checklist Guide</a> for more information.\n"
},
"unappliedPaymentAmount": {
"type": "string",
"format": "decimal",
"description": "The total unapplied amount of all posted payments in this currency.\n\n**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"unappliedCreditMemoAmount": {
"type": "string",
"format": "decimal",
"description": "The total unapplied amount of all posted credit memos in this currency.\n"
}
}
}
],
"title": "metricsData"
}
GETAccountPMAccountHolderInfo
{
"type": "object",
"title": "accountHolderInfo",
"properties": {
"city": {
"type": "string",
"description": "The city where the account holder stays. \n"
},
"email": {
"type": "string",
"description": "The email address of the account holder.\n"
},
"phone": {
"type": "string",
"description": "The phone number of the account holder.\n"
},
"state": {
"type": "string",
"description": "The state where the account holder stays.\n"
},
"country": {
"type": "string",
"description": "The country where the account holder stays.\n\nWhen creating a payment method through a translated UI or Payment Page, a country name in a translated language might be selected. Regardless of the country texts selected when creating the payment method, only the supported country name returns in this field. For a complete list of supported country names, see <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions\" target=\"_blank\">View countries or regions</a>. Internationalization is not supported for the API field value.\n"
},
"zipCode": {
"type": "string",
"description": "The zip code for the address of the account holder.\n"
},
"addressLine1": {
"type": "string",
"description": "The first line of the address for the account holder.\n"
},
"addressLine2": {
"type": "string",
"description": "The second line of the address for the account holder. \n"
},
"accountHolderName": {
"type": "string",
"maxLength": 60,
"description": "The full name of the account holder.\n"
}
},
"description": "The account holder information.\n"
}
GETAccountPaymentMethodType
{
"allOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"paymentGateway": {
"type": "string",
"description": "The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.\n"
},
"defaultPaymentMethodId": {
"type": "string",
"description": "ID of the default payment method for the account.\n"
},
"returnedPaymentMethodType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETPaymentMethodResponseForAccount"
},
"title": "Payment Method Type",
"description": "Container for a specific type of payment method on the customer account. For example, `creditcard`, `debitcard`, `creditcardreferencetransaction`, `ach`, etc. Each `returnedPaymentMethodType` array contains one or more payment methods of that payment method type.\n\n**Note:** The response could return more than one payment method type arrays. See **Response samples** as an example.\n"
}
}
},
{
"$ref": "#/components/schemas/CustomAccountPaymentMethod"
}
]
}
GETAccountSummaryInvoiceType
{
"type": "object",
"title": "invoices",
"properties": {
"id": {
"type": "string",
"description": "Invoice ID.\n"
},
"amount": {
"type": "number",
"description": "Invoice amount before adjustments, discounts, and similar items.\n"
},
"status": {
"type": "string",
"description": "Invoice status - not the payment status of the invoice, just the status of the invoice itself. Possible values are: `Posted`, `Draft`, `Canceled`, `Error`.\n"
},
"balance": {
"type": "string",
"format": "decimal",
"description": "Balance due on the invoice.\n"
},
"dueDate": {
"type": "string",
"format": "date",
"description": "Due date as `yyyy-mm-dd`.\n"
},
"invoiceDate": {
"type": "string",
"format": "date",
"description": "Invoice date as `yyyy-mm-dd`.\n"
},
"invoiceNumber": {
"type": "string",
"description": "Invoice number.\n"
}
}
}
GETAccountSummaryPaymentInvoiceType
{
"type": "object",
"title": "paidInvoices",
"properties": {
"invoiceId": {
"type": "string",
"description": "Invoice ID.\n"
},
"invoiceNumber": {
"type": "string",
"description": "Invoice number.\n"
},
"appliedPaymentAmount": {
"type": "string",
"format": "decimal",
"description": "Amount of payment applied to the invoice.\n"
}
}
}
GETAccountSummaryPaymentType
{
"type": "object",
"title": "payments",
"properties": {
"id": {
"type": "string",
"description": "Payment ID.\n"
},
"status": {
"type": "string",
"description": "Payment status. Possible values are: `Draft`, `Processing`, `Processed`, `Error`, `Voided`, `Canceled`, `Posted`.\n"
},
"paymentType": {
"type": "string",
"description": "Payment type; possible values are: `External`, `Electronic`.\n"
},
"paidInvoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETAccountSummaryPaymentInvoiceType"
},
"description": "Container for paid invoices for this subscription.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "Effective date as `yyyy-mm-dd`.\n"
},
"paymentNumber": {
"type": "string",
"description": "Payment number.\n"
}
}
}
GETAccountSummarySubscriptionRatePlanType
{
"type": "object",
"title": "ratePlans",
"properties": {
"productId": {
"type": "string",
"description": "Product ID.\n"
},
"productSku": {
"type": "string",
"description": ""
},
"productName": {
"type": "string",
"description": "Product name.\n"
},
"ratePlanName": {
"type": "string",
"description": "Rate plan name.\n"
},
"productRatePlanId": {
"type": "string",
"description": "Product Rate Plan ID.\n"
}
}
}
GETAccountSummarySubscriptionType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Subscription ID.\n"
},
"status": {
"type": "string",
"description": "Subscription status; possible values are: `Draft`, `PendingActivation`, `PendingAcceptance`, `Active`, `Cancelled`, `Expired`.\n"
},
"termType": {
"type": "string",
"description": "Possible values are: `TERMED`, `EVERGREEN`.\n"
},
"autoRenew": {
"type": "boolean",
"description": "If `true`, auto-renew is enabled. If `false`, auto-renew is disabled.\n"
},
"ratePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETAccountSummarySubscriptionRatePlanType"
},
"description": "Container for rate plans for this subscription.\n"
},
"initialTerm": {
"type": "string",
"description": "Duration of the initial subscription term in whole months. \n"
},
"renewalTerm": {
"type": "string",
"description": "Duration of the renewal term in whole months.\n"
},
"termEndDate": {
"type": "string",
"format": "date",
"description": "End date of the subscription term. If the subscription is evergreen, this is either null or equal to the cancellation date, as appropriate.\n"
},
"termStartDate": {
"type": "string",
"format": "date",
"description": "Start date of the subscription term. If this is a renewal subscription, this date is different than the subscription start date.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "Subscription Number.\n"
},
"subscriptionStartDate": {
"type": "string",
"format": "date",
"description": "Subscription start date.\n"
}
}
},
{
"$ref": "#/components/schemas/SubscriptionObjectQTFields"
},
{
"$ref": "#/components/schemas/SubscriptionObjectNSFields"
},
{
"$ref": "#/components/schemas/SubscriptionObjectCustomFields"
}
],
"title": "subscriptions"
}
GETAccountSummaryType
{
"type": "object",
"properties": {
"usage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETAccountSummaryUsageType"
},
"description": "Container for usage data. Only returns the last 6 months of usage.\n\n**Note:** If the Active Rating feature is enabled, no usage data is returned in the response body field.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"taxInfo": {
"type": "object",
"properties": {
"VATId": {
"type": "string",
"description": "EU Value Added Tax ID.\n"
},
"companyCode": {
"type": "string",
"description": "Unique code that identifies a company account in Avalara.\n"
},
"exemptStatus": {
"type": "string",
"description": "Status of the account tax exemption.\n"
},
"exemptDescription": {
"type": "string",
"description": "Description of the tax exemption certificate that the customer holds.\n"
},
"exemptCertificateId": {
"type": "string",
"description": "ID of the customer tax exemption certificate.\n"
},
"exemptEffectiveDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption starts.\n"
},
"exemptEntityUseCode": {
"type": "string",
"maxLength": 64,
"description": "A unique entity use code to apply exemptions in Avalara AvaTax.\n\nThis account-level field is required only when you choose Avalara as your tax engine. See [Exempt Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for more details.\n"
},
"exemptExpirationDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption expires.\n"
},
"exemptCertificateType": {
"type": "string",
"description": "Type of tax exemption certificate that the customer holds.\n"
},
"exemptIssuingJurisdiction": {
"type": "string",
"description": "Jurisdiction in which the customer tax exemption certificate was issued.\n"
}
},
"description": "Container for tax exempt information, used to establish the tax exempt status of a customer account.\n"
},
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETAccountSummaryInvoiceType"
},
"description": "Container for invoices. Only returns the last 6 invoices.\n"
},
"payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETAccountSummaryPaymentType"
},
"description": "Container for payments. Only returns the last 6 payments.\n"
},
"basicInfo": {
"$ref": "#/components/schemas/GETAccountSummaryTypeBasicInfo"
},
"billToContact": {
"$ref": "#/components/schemas/GETAccountSummaryTypeBillToContact"
},
"soldToContact": {
"$ref": "#/components/schemas/GETAccountSummaryTypeSoldToContact"
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETAccountSummarySubscriptionType"
},
"description": "Container for subscriptions.\n"
}
}
}
GETAccountSummaryTypeBasicInfo
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Account ID.\n"
},
"name": {
"type": "string",
"description": "Account name.\n"
},
"tags": {
"type": "string",
"description": ""
},
"batch": {
"type": "string",
"description": "The alias name given to a batch. A string of 50 characters or less.\n"
},
"status": {
"type": "string",
"description": "Account status; possible values are: `Active`, `Draft`, `Canceled`.\n"
},
"autoPay": {
"type": "boolean",
"description": "Whether future payments are automatically collected when they are due during a payment run.\n"
},
"balance": {
"type": "string",
"format": "decimal",
"description": "Current outstanding balance.\n"
},
"currency": {
"type": "string",
"description": "A currency as defined in Billing Settings in the Zuora UI.\n"
},
"billCycleDay": {
"type": "string",
"description": "Billing cycle day (BCD), the day of the month when a bill run generates invoices for the account.\n"
},
"accountNumber": {
"type": "string",
"description": "Account number.\n"
},
"partnerAccount": {
"type": "boolean",
"description": "Whether the customer account is a partner, distributor, or reseller. \n\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account\" target=\"_blank\">Reseller Account</a> feature enabled.\n"
},
"lastInvoiceDate": {
"type": "string",
"format": "date",
"description": "Date of the most recent invoice for the account; null if no invoice has ever been generated.\n"
},
"lastPaymentDate": {
"type": "string",
"format": "date",
"description": "Date of the most recent payment collected for the account. Null if no payment has ever been collected.\n"
},
"lastMetricsUpdate": {
"type": "string",
"format": "date-time",
"description": "The date and time when account metrics are last updated, if the account is a partner account.\n\n**Note**: \n - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account\" target=\"_blank\">Reseller Account</a> feature enabled.\n - If you have the Reseller Account feature enabled, and set the `partnerAccount` field to `false` for an account, the value of the `lastMetricsUpdate` field is automatically set to `null` in the response. \n - If you ever set the `partnerAccount` field to `true` for an account, the value of `lastMetricsUpdate` field is the time when the account metrics are last updated.\n \n"
},
"lastPaymentAmount": {
"type": "string",
"format": "decimal",
"description": "Amount of the most recent payment collected for the account; null if no payment has ever been collected.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "The purchase order number provided by your customer for services, products, or both purchased."
},
"defaultPaymentMethod": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the default payment method associated with this account.\n"
},
"creditCardType": {
"type": "string",
"description": "The type of the credit card.\n\nPossible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Methods](https://knowledgecenter.zuora.com/Zuora_Central/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods).\n"
},
"creditCardNumber": {
"type": "string",
"description": "Credit card number, 16 characters or less, displayed in masked format (e.g., ************1234).\n"
},
"paymentMethodType": {
"type": "string",
"description": ""
},
"creditCardExpirationYear": {
"type": "string",
"description": "Four-digit card expiration year as `yyyy`.\n"
},
"creditCardExpirationMonth": {
"type": "string",
"description": "Two-digit numeric card expiration month as `mm`.\n"
}
},
"description": ""
},
"additionalEmailAddresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of additional email addresses to receive email notifications.\n"
},
"invoiceDeliveryPrefsEmail": {
"type": "boolean",
"description": "Whether the customer wants to receive invoices through email. \n"
},
"invoiceDeliveryPrefsPrint": {
"type": "boolean",
"description": "Whether the customer wants to receive printed invoices, such as through postal mail.\n"
},
"paymentMethodCascadingConsent": {
"type": "boolean",
"description": "`true` indicates the consent from your customer to use the Cascading Payment Method feature was collected. \n`false` indicates the consent was not collected and the Cascading Payment Method feature is not enabled.\n"
}
}
},
{
"$ref": "#/components/schemas/AccountObjectNSFields"
},
{
"$ref": "#/components/schemas/AccountObjectCustomFields"
}
],
"title": "basicInfo",
"description": "Container for basic information about the account.\n"
}
GETAccountSummaryTypeBillToContact
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Contact ID.\n"
},
"fax": {
"type": "string",
"description": "Fax phone number, 40 characters or less.\n"
},
"city": {
"type": "string",
"description": "City, 40 characters or less.\n"
},
"state": {
"type": "string",
"description": "Full state name. This field does not contain the ISO-standard abbreviation of the state name.\n"
},
"county": {
"type": "string",
"description": "County; 32 characters or less. Zuora Tax uses this information to calculate county taxation. "
},
"country": {
"type": "string",
"description": "Full country name. This field does not contain the ISO-standard abbreviation of the country name.\n"
},
"zipCode": {
"type": "string",
"description": "Zip code, 20 characters or less.\n"
},
"address1": {
"type": "string",
"description": "First address line, 255 characters or less.\n"
},
"address2": {
"type": "string",
"description": "Second address line, 255 characters or less.\n"
},
"lastName": {
"type": "string",
"description": "Last name, 100 characters or less.\n"
},
"firstName": {
"type": "string",
"description": "First name, 100 characters or less.\n"
},
"taxRegion": {
"type": "string",
"description": "A region string, defined in your Zuora tax rules.\n"
},
"workEmail": {
"type": "string",
"description": "Work email address, 80 characters or less.\n"
},
"workPhone": {
"type": "string",
"description": "Work phone number, 40 characters or less.\n"
}
}
},
{
"$ref": "#/components/schemas/ContactObjectCustomFields"
}
],
"title": "Contact",
"description": "Container for bill-to contact information.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `billToContactId` field in the request or you select **Default Contact from Account** for the `billToContactId` field during subscription creation, the value of the `billToContact` field is automatically set to `null` in the response body.\n"
}
GETAccountSummaryTypeSoldToContact
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Contact ID.\n"
},
"fax": {
"type": "string",
"description": "Fax phone number, 40 characters or less.\n"
},
"city": {
"type": "string",
"description": "City, 40 characters or less.\n"
},
"state": {
"type": "string",
"description": "Full state name. This field does not contain the ISO-standard abbreviation of the state name.\n"
},
"county": {
"type": "string",
"description": "County; 32 characters or less. Zuora Tax uses this information to calculate county taxation. "
},
"country": {
"type": "string",
"description": "Full country name. This field does not contain the ISO-standard abbreviation of the country name.\n"
},
"zipCode": {
"type": "string",
"description": "Zip code, 20 characters or less.\n"
},
"address1": {
"type": "string",
"description": "First address line, 255 characters or less.\n"
},
"address2": {
"type": "string",
"description": "Second address line, 255 characters or less.\n"
},
"lastName": {
"type": "string",
"description": "Last name, 100 characters or less.\n"
},
"firstName": {
"type": "string",
"description": "First name, 100 characters or less.\n"
},
"taxRegion": {
"type": "string",
"description": "A region string, defined in your Zuora tax rules.\n"
},
"workEmail": {
"type": "string",
"description": "Work email address, 80 characters or less.\n"
},
"workPhone": {
"type": "string",
"description": "Work phone number, 40 characters or less.\n"
}
}
},
{
"$ref": "#/components/schemas/ContactObjectCustomFields"
}
],
"title": "Contact",
"description": "Container for sold-to contact information.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `soldToContactId` field in the request or you select **Default Contact from Account** for the `soldToContactId` field during subscription creation, the value of the `soldToContact` field is automatically set to `null` in the response body.\n"
}
GETAccountSummaryUsageType
{
"type": "object",
"title": "usage",
"properties": {
"quantity": {
"type": "string",
"format": "decimal",
"description": "Number of units used.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of a usage period as `yyyy-mm`. Zuora uses this field value to determine the usage date.\n"
},
"unitOfMeasure": {
"type": "string",
"description": "Unit by which consumption is measured, as configured in the Billing Settings section of the web-based UI.\n"
}
}
}
GETAccountType
{
"type": "object",
"properties": {
"metrics": {
"type": "object",
"properties": {
"balance": {
"type": "string",
"format": "decimal",
"description": "The customer's total invoice balance minus credit balance.\n"
},
"contractedMrr": {
"type": "string",
"format": "decimal",
"description": "Future expected MRR that accounts for future upgrades, downgrades, upsells and cancellations.\n"
},
"creditBalance": {
"type": "string",
"format": "decimal",
"description": "Current credit balance.\n"
},
"totalInvoiceBalance": {
"type": "string",
"format": "decimal",
"description": "Total balance of all posted invoices.\n"
},
"reservedPaymentAmount": {
"type": "number",
"format": "float",
"description": "The Reserved Payment Amount of the customer account. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information. \n"
},
"totalDebitMemoBalance": {
"type": "string",
"format": "decimal",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nTotal balance of all posted debit memos.\n"
},
"unappliedPaymentAmount": {
"type": "string",
"format": "decimal",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nTotal unapplied amount of all posted payments.\n"
},
"unappliedCreditMemoAmount": {
"type": "string",
"format": "decimal",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nTotal unapplied amount of all posted credit memos.\n"
}
},
"description": "Container for account metrics of the account's default currency. \nIf you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currencies</a> feature enabled, the `metricsData` field provides account metrics of different currencies.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"taxInfo": {
"type": "object",
"properties": {
"VATId": {
"type": "string",
"description": "EU Value Added Tax ID.\n"
},
"companyCode": {
"type": "string",
"description": "Unique code that identifies a company account in Avalara.\n"
},
"exemptStatus": {
"type": "string",
"description": "Status of the account tax exemption.\n"
},
"exemptDescription": {
"type": "string",
"description": "Description of the tax exemption certificate that the customer holds.\n"
},
"exemptCertificateId": {
"type": "string",
"description": "ID of the customer tax exemption certificate.\n"
},
"exemptEffectiveDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption starts.\n"
},
"exemptEntityUseCode": {
"type": "string",
"maxLength": 64,
"description": "A unique entity use code to apply exemptions in Avalara AvaTax.\n\nThis account-level field is required only when you choose Avalara as your tax engine. See [Exempt Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for more details.\n"
},
"exemptExpirationDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption expires.\n"
},
"exemptCertificateType": {
"type": "string",
"description": "Type of tax exemption certificate that the customer holds.\n"
},
"exemptIssuingJurisdiction": {
"type": "string",
"description": "Jurisdiction in which the customer tax exemption certificate was issued.\n"
}
},
"description": "Container for tax exempt information, used to establish the tax exempt status of a customer account.\n"
},
"basicInfo": {
"$ref": "#/components/schemas/GETAccountTypeBasicInfo"
},
"metricsData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETAccountCurrencyMetricsType"
},
"description": "Container for account metrics of different currencies.\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currencies</a> feature enabled.\n"
},
"billToContact": {
"$ref": "#/components/schemas/GETAccountTypeBillToContact"
},
"soldToContact": {
"$ref": "#/components/schemas/GETAccountTypeSoldToContact"
},
"einvoiceProfile": {
"$ref": "#/components/schemas/GetAccountEInvoiceProfile"
},
"billingAndPayment": {
"type": "object",
"properties": {
"autoPay": {
"type": "boolean",
"description": "Whether future payments are automatically collected when they are due during a payment run.\n\n"
},
"currency": {
"type": "string",
"description": "A currency defined in the web-based UI administrative settings.\n"
},
"paymentTerm": {
"type": "string",
"description": "A payment-terms indicator defined in the web-based UI administrative settings, e.g., \"Net 30\".\n"
},
"billCycleDay": {
"type": "string",
"description": "Billing cycle day (BCD), the day of the month when a bill run generates invoices for the account.\n"
},
"paymentGateway": {
"type": "string",
"description": "The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.\n"
},
"defaultPaymentMethodId": {
"type": "string",
"description": "ID of the default payment method for the account.\n"
},
"additionalEmailAddresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of additional email addresses to receive email notifications.\n"
},
"invoiceDeliveryPrefsEmail": {
"type": "boolean",
"description": "Whether the customer wants to receive invoices through email. \n"
},
"invoiceDeliveryPrefsPrint": {
"type": "boolean",
"description": "Whether the customer wants to receive printed invoices, such as through postal mail.\n"
},
"paymentMethodCascadingConsent": {
"type": "boolean",
"description": "`true` indicates the consent from your customer to use the Cascading Payment Method feature was collected. \n`false` indicates the consent was not collected and the Cascading Payment Method feature is not enabled.\n"
}
},
"description": "Container for billing and payment information for the account."
}
}
}
GETAccountTypeBasicInfo
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Account ID.\n"
},
"name": {
"type": "string",
"description": "Account name.\n"
},
"tags": {
"type": "string",
"description": ""
},
"batch": {
"type": "string",
"description": "The alias name given to a batch. A string of 50 characters or less.\n"
},
"crmId": {
"type": "string",
"description": "CRM account ID for the account, up to 100 characters.\n"
},
"notes": {
"type": "string",
"description": "Notes associated with the account, up to 65,535 characters.\n"
},
"status": {
"type": "string",
"description": "Account status; possible values are: `Active`, `Draft`, `Canceled`.\n"
},
"parentId": {
"type": "string",
"description": "Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\" target=\"_blank\">Customer Hierarchy</a> enabled."
},
"salesRep": {
"type": "string",
"description": "The name of the sales representative associated with this account, if applicable. Maximum of 50 characters."
},
"accountNumber": {
"type": "string",
"description": "Account number.\n"
},
"profileNumber": {
"type": "string",
"description": "The number of the communication profile that this account is linked to."
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the billing document sequence set that is assigned to the customer account. \n"
},
"partnerAccount": {
"type": "boolean",
"description": "Whether the customer account is a partner, distributor, or reseller. \n\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account\" target=\"_blank\">Reseller Account</a> feature enabled.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "Invoice template ID, configured in Billing Settings in the Zuora UI.\n"
},
"lastMetricsUpdate": {
"type": "string",
"format": "date-time",
"description": "The date and time when account metrics are last updated, if the account is a partner account.\n\n**Note**: \n - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account\" target=\"_blank\">Reseller Account</a> feature enabled.\n - If you have the Reseller Account feature enabled, and set the `partnerAccount` field to `false` for an account, the value of the `lastMetricsUpdate` field is automatically set to `null` in the response. \n - If you ever set the `partnerAccount` field to `true` for an account, the value of `lastMetricsUpdate` field is the time when the account metrics are last updated.\n \n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"debitMemoTemplateId": {
"type": "string",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThe unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "The purchase order number provided by your customer for services, products, or both purchased."
},
"creditMemoTemplateId": {
"type": "string",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThe unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.\n"
},
"communicationProfileId": {
"type": "string",
"description": "The ID of the communication profile that this account is linked to."
}
}
},
{
"$ref": "#/components/schemas/AccountObjectNSFields"
},
{
"$ref": "#/components/schemas/AccountObjectCustomFields"
}
],
"title": "basicInfo",
"description": "Container for basic information about the account.\n"
}
GETAccountTypeBillToContact
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the person to bill for the account, 32 characters or less."
},
"fax": {
"type": "string",
"description": "Fax phone number, 40 characters or less.\n"
},
"city": {
"type": "string",
"description": "City, 40 characters or less.\n"
},
"state": {
"type": "string",
"description": "Full state name. This field does not contain the ISO-standard abbreviation of the state name.\n"
},
"county": {
"type": "string",
"description": "County; 32 characters or less. Zuora Tax uses this information to calculate county taxation. "
},
"country": {
"type": "string",
"description": "Full country name. This field does not contain the ISO-standard abbreviation of the country name.\n"
},
"zipCode": {
"type": "string",
"description": "Zip code, 20 characters or less.\n"
},
"address1": {
"type": "string",
"description": "First address line, 255 characters or less.\n"
},
"address2": {
"type": "string",
"description": "Second address line, 255 characters or less.\n"
},
"lastName": {
"type": "string",
"description": "Last name, 100 characters or less.\n"
},
"nickname": {
"type": "string",
"description": "Nickname for this contact.\n"
},
"firstName": {
"type": "string",
"description": "First name, 100 characters or less.\n"
},
"homePhone": {
"type": "string",
"description": "Home phone number, 40 characters or less.\n"
},
"taxRegion": {
"type": "string",
"description": "A region string, defined in your Zuora tax rules.\n"
},
"workEmail": {
"type": "string",
"description": "Work email address, 80 characters or less.\n"
},
"workPhone": {
"type": "string",
"description": "Work phone number, 40 characters or less.\n"
},
"otherPhone": {
"type": "string",
"description": "Other phone number, 40 characters or less.\n"
},
"mobilePhone": {
"type": "string",
"description": "Mobile phone number, 40 characters or less.\n"
},
"personalEmail": {
"type": "string",
"description": "Personal email address, 80 characters or less.\n"
},
"otherPhoneType": {
"type": "string",
"description": "Possible values are: `Work`, `Mobile`, `Home`, `Other`.\n"
}
}
},
{
"$ref": "#/components/schemas/ContactObjectCustomFields"
}
],
"title": "Contact",
"description": "Container for bill-to contact information.\n"
}
GETAccountTypeSoldToContact
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the person who bought the subscription associated with the account, 32 characters or less."
},
"fax": {
"type": "string",
"description": "Fax phone number, 40 characters or less.\n"
},
"city": {
"type": "string",
"description": "City, 40 characters or less.\n"
},
"state": {
"type": "string",
"description": "Full state name. This field does not contain the ISO-standard abbreviation of the state name.\n"
},
"county": {
"type": "string",
"description": "County; 32 characters or less. Zuora tax uses this information to calculate county taxation. "
},
"country": {
"type": "string",
"description": "Full country name. This field does not contain the ISO-standard abbreviation of the country name.\n"
},
"zipCode": {
"type": "string",
"description": "Zip code, 20 characters or less.\n"
},
"address1": {
"type": "string",
"description": "First address line, 255 characters or less.\n"
},
"address2": {
"type": "string",
"description": "Second address line, 255 characters or less.\n"
},
"lastName": {
"type": "string",
"description": "Last name, 100 characters or less.\n"
},
"nickname": {
"type": "string",
"description": "Nickname for this contact.\n"
},
"firstName": {
"type": "string",
"description": "First name, 100 characters or less.\n"
},
"homePhone": {
"type": "string",
"description": "Home phone number, 40 characters or less.\n"
},
"taxRegion": {
"type": "string",
"description": "A region string, defined in your Zuora tax rules.\n"
},
"workEmail": {
"type": "string",
"description": "Work email address, 80 characters or less.\n"
},
"workPhone": {
"type": "string",
"description": "Work phone number, 40 characters or less.\n"
},
"otherPhone": {
"type": "string",
"description": "Other phone number, 40 characters or less.\n"
},
"mobilePhone": {
"type": "string",
"description": "Mobile phone number, 40 characters or less.\n"
},
"personalEmail": {
"type": "string",
"description": "Personal email address, 80 characters or less.\n"
},
"otherPhoneType": {
"type": "string",
"description": "Possible values are: `Work`, `Mobile`, `Home`, `Other`.\n"
}
}
},
{
"$ref": "#/components/schemas/ContactObjectCustomFields"
}
],
"title": "Contact",
"description": "Container for sold-to contact information. Uses the same field structure as billToContact.\n"
}
GETAccountingCodeItemType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the accounting code.\n"
},
"name": {
"type": "string",
"description": "Name of the accounting code.\n"
},
"type": {
"enum": [
"AccountsReceivable",
"On-Account Receivable",
"Cash",
"OtherAssets",
"CustomerCashOnAccount",
"DeferredRevenue",
"SalesTaxPayable",
"OtherLiabilities",
"SalesRevenue",
"SalesDiscounts",
"OtherRevenue",
"OtherEquity",
"BadDebt",
"OtherExpenses"
],
"type": "string",
"description": "Accounting code type. \n\nNote that `On-Account Receivable` is only available if you enable the Invoice Settlement feature. \n"
},
"notes": {
"type": "string",
"description": "Any optional notes for the accounting code.\n"
},
"status": {
"enum": [
"Active",
"Inactive"
],
"type": "string",
"description": "The accounting code status.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"category": {
"enum": [
"Assets",
"Liabilities",
"Equity",
"Revenue",
"Expenses"
],
"type": "string",
"description": "The category associated with the accounting code.\n"
},
"createdBy": {
"type": "string",
"description": "The ID of the user who created the accounting code.\n"
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "Date and time when the accounting code was created.\n"
},
"updatedBy": {
"type": "string",
"description": "The ID of the user who last updated the accounting code.\n"
},
"updatedOn": {
"type": "string",
"format": "date-time",
"description": "Date and time when the accounting code was last updated.\n"
},
"glAccountName": {
"type": "string",
"description": "Name of the account in your general ledger.\n\nField only available if you have Zuora Finance enabled.\n"
},
"glAccountNumber": {
"type": "string",
"description": "Account number in your general ledger.\n\nField only available if you have Zuora Finance enabled.\n"
}
}
},
{
"$ref": "#/components/schemas/AccountingCodeObjectCustomFields"
}
]
}
GETAccountingCodeItemWithoutSuccessType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the accounting code.\n"
},
"name": {
"type": "string",
"description": "Name of the accounting code.\n"
},
"type": {
"enum": [
"AccountsReceivable",
"On-Account Receivable",
"Cash",
"OtherAssets",
"CustomerCashOnAccount",
"DeferredRevenue",
"SalesTaxPayable",
"OtherLiabilities",
"SalesRevenue",
"SalesDiscounts",
"OtherRevenue",
"OtherEquity",
"BadDebt",
"OtherExpenses"
],
"type": "string",
"description": "Accounting code type. \n\nNote that `On-Account Receivable` is only available if you enable the Invoice Settlement feature. \n"
},
"notes": {
"type": "string",
"description": "Any optional notes for the accounting code.\n"
},
"status": {
"enum": [
"Active",
"Inactive"
],
"type": "string",
"description": "The accounting code status.\n"
},
"category": {
"enum": [
"Assets",
"Liabilities",
"Equity",
"Revenue",
"Expenses"
],
"type": "string",
"description": "The category associated with the accounting code.\n"
},
"createdBy": {
"type": "string",
"description": "The ID of the user who created the accounting code.\n"
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "Date and time when the accounting code was created.\n"
},
"updatedBy": {
"type": "string",
"description": "The ID of the user who last updated the accounting code.\n"
},
"updatedOn": {
"type": "string",
"format": "date-time",
"description": "Date and time when the accounting code was last updated.\n"
},
"glAccountName": {
"type": "string",
"description": "Name of the account in your general ledger.\n\nField only available if you have Zuora Finance enabled.\n"
},
"glAccountNumber": {
"type": "string",
"description": "Account number in your general ledger.\n\nField only available if you have Zuora Finance enabled.\n"
}
}
},
{
"$ref": "#/components/schemas/AccountingCodeObjectCustomFields"
}
],
"title": "accountingCodes"
}
GETAccountingCodesType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"accountingCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETAccountingCodeItemWithoutSuccessType"
},
"description": "An array of all the accounting codes in your chart of accounts. Each accounting code has the following fields.\n"
}
}
}
GETAccountingPeriodType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the accounting period.\n"
},
"name": {
"type": "string",
"description": "Name of the accounting period.\n"
},
"notes": {
"type": "string",
"description": "Any optional notes about the accounting period.\n"
},
"status": {
"type": "string",
"description": "Status of the accounting period. Possible values:\n* `Open`\n* `PendingClose`\n* `Closed`\n"
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date of the accounting period.\n"
},
"fileIds": {
"type": "object",
"properties": {
"revenueDetailCsvFileId": {
"type": "string",
"description": "File ID of the Revenue Detail report in CSV format.\n"
},
"revenueDetailExcelFileId": {
"type": "string",
"description": "File ID of the Revenue Detail report in XLSX format.\n"
},
"unprocessedChargesFileId": {
"type": "string",
"description": "File ID of a report containing all unprocessed charges for the accounting period.\n"
},
"arRollForwardDetailExportFileId": {
"type": "string",
"description": "File ID of the Accounts Receivable Detail report.\n"
},
"fxRealizedGainAndLossDetailExportFileId": {
"type": "string",
"description": "File ID of the Realized Gain and Loss Detail report.\n\nReturned only if you have Foreign Currency Conversion enabled.\n"
},
"fxUnrealizedGainAndLossDetailExportFileId": {
"type": "string",
"description": "File ID of the Unrealized Gain and Loss Detail report.\n\nReturned only if you have Foreign Currency Conversion enabled\n"
},
"accountsReceivableAccountAgingDetailExportFileId": {
"type": "string",
"description": "File ID of the Accounts Receivable Aging Account Detail report.\n"
},
"accountsReceivableInvoiceAgingDetailExportFileId": {
"type": "string",
"description": "File ID of the Accounts Receivable Aging Invoice Detail report.\n"
}
},
"description": "File IDs of the reports available for the accounting period. You can retrieve the reports by specifying the file ID in a [Get Files](https://developer.zuora.com/api-references/api/operation/GET_Files) REST API call.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"createdBy": {
"type": "string",
"description": "ID of the user who created the accounting period.\n"
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "Date and time when the accounting period was created.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the accounting period.\n"
},
"updatedBy": {
"type": "string",
"description": "ID of the user who last updated the accounting period.\n"
},
"updatedOn": {
"type": "string",
"format": "date-time",
"description": "Date and time when the accounting period was last updated.\n"
},
"fiscalYear": {
"type": "string",
"description": "Fiscal year of the accounting period.\n"
},
"fiscal_quarter": {
"type": "integer",
"format": "int64",
"description": ""
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled. \n"
},
"runTrialBalanceEnd": {
"type": "string",
"format": "date-time",
"description": "Date and time that the trial balance was completed. If the trial balance status is `Pending`, `Processing`, or `Error`, this field is `null`.\n"
},
"runTrialBalanceStart": {
"type": "string",
"format": "date-time",
"description": "Date and time that the trial balance was run. If the trial balance status is Pending, this field is null.\n"
},
"runTrialBalanceStatus": {
"type": "string",
"description": "Status of the trial balance for the accounting period. Possible values:\n\n* `Pending`\n* `Processing`\n* `Completed`\n* `Error`\n"
},
"runTrialBalanceErrorMessage": {
"type": "string",
"description": "If trial balance status is Error, an error message is returned in this field.\n"
}
}
},
{
"$ref": "#/components/schemas/AccountingPeriodObjectCustomFields"
}
]
}
GETAccountingPeriodWithoutSuccessType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the accounting period.\n"
},
"name": {
"type": "string",
"description": "Name of the accounting period.\n"
},
"notes": {
"type": "string",
"description": "Any optional notes about the accounting period.\n"
},
"status": {
"type": "string",
"description": "Status of the accounting period. Possible values:\n\n* `Open`\n* `PendingClose`\n* `Closed`\n"
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date of the accounting period.\n"
},
"fileIds": {
"type": "object",
"properties": {
"revenueDetailCsvFileId": {
"type": "string",
"description": "File ID of the Revenue Detail report in CSV format.\n"
},
"revenueDetailExcelFileId": {
"type": "string",
"description": "File ID of the Revenue Detail report in XLSX format.\n"
},
"unprocessedChargesFileId": {
"type": "string",
"description": "File ID of a report containing all unprocessed charges for the accounting period.\n"
},
"arRollForwardDetailExportFileId": {
"type": "string",
"description": "File ID of the Accounts Receivable Detail report.\n"
},
"fxRealizedGainAndLossDetailExportFileId": {
"type": "string",
"description": "File ID of the Realized Gain and Loss Detail report.\n\nReturned only if you have Foreign Currency Conversion enabled.\n"
},
"fxUnrealizedGainAndLossDetailExportFileId": {
"type": "string",
"description": "File ID of the Unrealized Gain and Loss Detail report.\n\nReturned only if you have Foreign Currency Conversion enabled\n"
},
"accountsReceivableAccountAgingDetailExportFileId": {
"type": "string",
"description": "File ID of the Accounts Receivable Aging Account Detail report.\n"
},
"accountsReceivableInvoiceAgingDetailExportFileId": {
"type": "string",
"description": "File ID of the Accounts Receivable Aging Invoice Detail report.\n"
}
},
"description": "File IDs of the reports available for the accounting period. You can retrieve the reports by specifying the file ID in a [Get Files](https://developer.zuora.com/api-references/api/operation/GET_Files) REST API call.\n"
},
"createdBy": {
"type": "string",
"description": "ID of the user who created the accounting period.\n"
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "Date and time when the accounting period was created.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the accounting period.\n"
},
"updatedBy": {
"type": "string",
"description": "D of the user who last updated the accounting period.\n"
},
"updatedOn": {
"type": "string",
"format": "date-time",
"description": "Date and time when the accounting period was last updated.\n"
},
"fiscalYear": {
"type": "string",
"description": "Fiscal year of the accounting period.\n"
},
"fiscal_quarter": {
"type": "integer",
"format": "int64",
"description": ""
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled. \n"
},
"runTrialBalanceEnd": {
"type": "string",
"format": "date-time",
"description": "Date and time that the trial balance was completed. If the trial balance status is `Pending`, `Processing`, or `Error`, this field is `null`.\n"
},
"runTrialBalanceStart": {
"type": "string",
"format": "date-time",
"description": "Date and time that the trial balance was run. If the trial balance status is `Pending`, this field is `null`.\n"
},
"runTrialBalanceStatus": {
"type": "string",
"description": "Status of the trial balance for the accounting period. Possible values:\n\n* `Pending`\n* `Processing`\n* `Completed`\n* `Error`\n"
},
"runTrialBalanceErrorMessage": {
"type": "string",
"description": "If trial balance status is Error, an error message is returned in this field.\n"
}
}
},
{
"$ref": "#/components/schemas/AccountingPeriodObjectCustomFields"
}
],
"title": "accountingPeriods"
}
GETAccountingPeriodsType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"accountingPeriods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETAccountingPeriodWithoutSuccessType"
},
"description": "An array of all accounting periods on your tenant. The accounting periods are returned in ascending order of start date; that is, the latest period is returned first.\n"
}
}
}
GETAdjustmentByIdResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"amount": {
"type": "string",
"format": "number",
"description": "The amount of the delivery adjustment.\n"
},
"reason": {
"type": "string",
"description": "The reason for the delivery adjustment.\n"
},
"status": {
"type": "string",
"description": "The status of the delivery adjustment will be `Billed` or `Cancelled`. \n"
},
"billingDate": {
"type": "string",
"format": "date",
"description": "The billing date is same as the delivery date of the delivery adjustment, in `yyyy-mm-dd` format.\n"
},
"deliveryDay": {
"type": "string",
"format": "string",
"description": "The delivery adjustment day of the week.\n"
},
"adjustmentId": {
"type": "string",
"format": "UUID",
"description": "The system generated delivery adjustment ID.\n"
},
"chargeNumber": {
"type": "string",
"description": "The charge number in the subscription for which the delivery adjustment is created.\n"
},
"deliveryDate": {
"type": "string",
"format": "date",
"description": "The delivery adjustment date, in `yyyy-mm-dd` format.\n"
},
"debitMemoNumber": {
"type": "string",
"description": "The Debit Memo generated to write off the Credit Memo for the delivery adjustment. \n\n**Note**: This field is only visible when the delivery adjustment is in `Cancelled` status.\n"
},
"adjustmentNumber": {
"type": "string",
"format": "string",
"description": "The system generated delivery adjustment Number.\n"
},
"creditMemoNumber": {
"type": "string",
"description": "The Credit Memo generated for the delivery adjustment.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "The subscription number for which the delivery adjustment is created.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n\n**Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability. \n\n**Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n\n**Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.\n"
}
}
}
]
}
GETAdjustmentsBySubscriptionNumberResponseType
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"adjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETAdjustmentByIdResponseType"
},
"description": "Container for all the delivery adjustments of a subscription.\n"
}
}
}
]
}
GETAdjustmentsResponseType
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"adjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTAdjustmentResponseType"
},
"description": "Container for delivery adjustments of a subscription.\n"
},
"totalAmount": {
"type": "string",
"format": "number",
"description": "The total amount of all the delivery adjustments.\n"
},
"ineligibleAdjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTIneligibleAdjustmentResponseType"
},
"description": "Container for ineligible delivery adjustments of a subscription.\n"
},
"totalNumberOfDeliveries": {
"type": "number",
"description": "The total number of all delivery adjustments.\n"
}
}
}
]
}
GETAllCustomObjectDefinitionsInNamespaceResponse
{
"type": "object",
"example": {
"count": 2,
"definitions": {
"Delivery": {
"Id": "362e0954-7108-49ca-abb0-6f628478e77f",
"type": "Delivery",
"schema": {
"label": "Delivery",
"object": "Delivery",
"required": [
"SubscriptionId__c",
"ContactId__c",
"ProductName__c",
"Quantity__c",
"ShippingDate__c",
"Id",
"CreatedById",
"UpdatedById",
"CreatedDate",
"UpdatedDate"
],
"filterable": [
"ContactId__c",
"SubscriptionId__c",
"Quantity__c",
"ProductName__c",
"Cancelled__c",
"ShippingStatus__c",
"Id",
"CreatedById",
"UpdatedById",
"CreatedDate",
"UpdatedDate"
],
"properties": {
"Id": {
"type": "string",
"label": "Id",
"format": "uuid",
"origin": "system"
},
"CreatedById": {
"type": "string",
"label": "CreatedById",
"origin": "system"
},
"CreatedDate": {
"type": "string",
"label": "CreatedDate",
"format": "date-time",
"origin": "system"
},
"Quantity__c": {
"type": "integer",
"label": "Quantity",
"origin": "custom",
"maximum": 20,
"minimum": 1,
"description": "The quantity of product that is being shipped to customer."
},
"UpdatedById": {
"type": "string",
"label": "UpdatedById",
"origin": "system"
},
"UpdatedDate": {
"type": "string",
"label": "UpdatedDate",
"format": "date-time",
"origin": "system"
},
"Cancelled__c": {
"type": "boolean",
"label": "Shipment Cancelled",
"origin": "custom",
"default": false,
"description": "Indicator is true when the customer has cancelled this particular shipment."
},
"ContactId__c": {
"type": "string",
"label": "Ship To Customer",
"format": "uuid",
"origin": "custom",
"description": "The customer contact who will receive the shipment."
},
"ProductName__c": {
"type": "string",
"label": "Product Name",
"origin": "custom",
"maxLength": 512,
"description": "The name of the product that is being shipped to customer."
},
"TotalWeight__c": {
"type": "number",
"label": "Total Weight (lbs.)",
"origin": "custom",
"minimum": 0,
"description": "The total weight of the product and packaging that is being shipped to customer."
},
"ContactEmail__c": {
"type": "string",
"label": "Customer Email",
"origin": "custom",
"maxLength": 128,
"description": "The customer's email address."
},
"ShippingDate__c": {
"type": "string",
"label": "Shipping Date",
"format": "date",
"origin": "custom",
"description": "The date the product will be sent to shipping vendor for delivery."
},
"ShippingStatus__c": {
"enum": [
"Pending",
"Preparing shipment",
"Waiting for tracking information",
"Shipped"
],
"type": "string",
"label": "Shipping Status",
"origin": "custom",
"default": "Pending",
"maxLength": 512,
"description": "The status of the shipment - e.g. Pending, Preparing shipment, Waiting for tracking information, or Shipped."
},
"SubscriptionId__c": {
"type": "string",
"label": "Subscription",
"format": "uuid",
"origin": "custom",
"description": "The subscription that is associated with the shipment record."
},
"CancellationTime__c": {
"type": "string",
"label": "Cancellation Time",
"format": "date-time",
"origin": "custom",
"description": "The time at which customer cancelled this particular shipment."
}
},
"description": "Delivery schedule for shipping products based on customer's subscription.",
"relationships": [
{
"fields": {
"ContactId__c": "Id"
},
"object": "contact",
"namespace": "com_zuora",
"cardinality": "manyToOne",
"recordConstraints": {
"create": {
"enforceValidMapping": false
}
}
},
{
"fields": {
"SubscriptionId__c": "Id"
},
"object": "subscription",
"namespace": "com_zuora",
"cardinality": "manyToOne",
"recordConstraints": {
"create": {
"enforceValidMapping": false
}
}
}
]
},
"CreatedById": "2c92c0f9-6a07-409d-016a-0a58ab1172eb",
"CreatedDate": "2021-04-29T04:06:07.876Z",
"UpdatedById": "2c92c0f9-6a07-409d-016a-0a58ab1172eb",
"UpdatedDate": "2021-04-29T04:06:07.876Z"
},
"birth_place_custom_object": {
"Id": "25924740-669d-4bcd-97b2-61c7410c7563",
"type": "birth_place_custom_object",
"schema": {
"type": "object",
"label": "Birth Place Custom Object",
"object": "birth_place_custom_object",
"required": [
"city__c",
"state__c",
"country__c",
"Id",
"CreatedById",
"UpdatedById",
"CreatedDate",
"UpdatedDate"
],
"filterable": [
"ContactId__c",
"city__c",
"Id",
"CreatedById",
"UpdatedById",
"CreatedDate",
"UpdatedDate"
],
"properties": {
"Id": {
"type": "string",
"label": "Id",
"format": "uuid",
"origin": "system"
},
"city__c": {
"type": "string",
"label": "city label",
"origin": "custom",
"maxLength": 512
},
"state__c": {
"type": "string",
"label": "state label",
"origin": "custom",
"maxLength": 512
},
"country__c": {
"type": "string",
"label": "country label",
"origin": "custom",
"maxLength": 512
},
"CreatedById": {
"type": "string",
"label": "CreatedById",
"origin": "system"
},
"CreatedDate": {
"type": "string",
"label": "CreatedDate",
"format": "date-time",
"origin": "system"
},
"UpdatedById": {
"type": "string",
"label": "UpdatedById",
"origin": "system"
},
"UpdatedDate": {
"type": "string",
"label": "UpdatedDate",
"format": "date-time",
"origin": "system"
},
"ContactId__c": {
"type": "string",
"label": "Contact",
"format": "uuid",
"origin": "custom"
}
},
"relationships": [
{
"fields": {
"ContactId__c": "Id"
},
"object": "contact",
"namespace": "com_zuora",
"cardinality": "manyToOne",
"recordConstraints": {
"create": {
"enforceValidMapping": false
}
}
}
]
},
"CreatedById": "2c92c0f9-6a07-409d-016a-0a58ab1172eb",
"CreatedDate": "2021-04-29T04:06:07.876Z",
"UpdatedById": "2c92c0f9-6a07-409d-016a-0a58ab1172eb",
"UpdatedDate": "2021-04-29T04:06:07.876Z"
}
}
},
"properties": {
"count": {
"type": "integer",
"description": "The number of objects in the `definitions` object. The value of this field is the number of custom object definitions in the namespace."
},
"definitions": {
"$ref": "#/components/schemas/CustomObjectDefinitions"
}
}
}
GETAttachmentResponseType
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of this attachment.\n"
},
"fileId": {
"type": "string",
"description": "File ID of the attached file. Use this file ID with [Get files](https://developer.zuora.com/api-references/api/operation/GET_Files) to download the file.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"fileName": {
"type": "string",
"description": "Attachment file name.\n"
},
"createdBy": {
"type": "string",
"description": "Zuora user id who added this attachment to the object.\n"
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "Date and time when the attachment was added to the object.\n"
},
"updatedBy": {
"type": "string",
"description": "Zuora user id who last updated the attachment.\n"
},
"updatedOn": {
"type": "string",
"format": "date-time",
"description": "Date and time when the attachment was last updated.\n"
},
"description": {
"type": "string",
"description": "Description of the attachment.\n"
},
"fileContentType": {
"type": "string",
"description": "File type.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
}
}
}
GETAttachmentResponseWithoutSuccessType
{
"type": "object",
"title": "attachments",
"properties": {
"id": {
"type": "string",
"description": "Zuora id of this attachement.\n"
},
"fileId": {
"type": "string",
"description": "File ID of the attached file. Use this file ID with [Get files](https://developer.zuora.com/api-references/api/operation/GET_Files) to download the file.\n"
},
"fileName": {
"type": "string",
"description": "Attachment file name.\n"
},
"createdBy": {
"type": "string",
"description": "Zuora user id of who added this attachment to the object.\n"
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "Date and time when the attachment was added to the object.\n"
},
"updatedBy": {
"type": "string",
"description": "Zuora user id who last updated the attachment.\n"
},
"updatedOn": {
"type": "string",
"format": "date-time",
"description": "Date and time when the attachment was last updated.\n"
},
"description": {
"type": "string",
"description": "Description of the attachment.\n"
},
"fileContentType": {
"type": "string",
"description": "Attachment file type.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
}
}
}
GETAttachmentsResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETAttachmentResponseWithoutSuccessType"
},
"description": "Container for one or more attachments.\n"
}
}
}
GETBillingDocumentFilesDeletionJobResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the billing document file deletion job.\n"
},
"status": {
"enum": [
"Pending",
"Processing",
"Completed",
"Error"
],
"type": "string",
"description": "The status of the billing document file deletion job.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
}
}
}
GETBillingDocumentsResponseType
{
"type": "object",
"title": "documents",
"properties": {
"id": {
"type": "string",
"description": "The ID of the billing document.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the billing document.\n"
},
"status": {
"enum": [
"Draft",
"Posted",
"Canceled",
"Error"
],
"type": "string",
"description": "The current status of the billing document.\n"
},
"balance": {
"type": "number",
"format": "double",
"description": "The balance of the billing document.\n"
},
"currency": {
"type": "string",
"nullable": true,
"description": "The currency of the billing document.\n\n**Note:** By default, the currency on a billing document matches the default currency set on the associated account. \nHowever, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. \nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currency</a>.\n"
},
"accountId": {
"type": "string",
"format": "uuid",
"description": "The ID of the customer account associated with the billing document."
},
"documentDate": {
"type": "string",
"format": "date",
"description": "The date of the billing document. The date can be the invoice date for invoices, credit memo date for credit memos, or debit memo date for debit memos.\n"
},
"documentType": {
"enum": [
"Invoice",
"CreditMemo",
"DebitMemo"
],
"type": "string",
"description": "The type of the billing document.\n"
},
"documentNumber": {
"type": "string",
"description": "The number of the billing document.\n"
}
}
}
GETBookingDateJobResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Job ID"
},
"status": {
"enum": [
"ACCEPTED",
"PROCESSING",
"COMPLETED",
"FAILED",
"STOPPED"
],
"type": "string",
"description": "The status of the booking date backfill job\n"
},
"progress": {
"type": "string",
"description": "The progress of the booking date backfill job\n"
},
"createdOn": {
"type": "integer",
"format": "int64",
"description": "The created-on date in the `int64` format\n"
},
"updatedOn": {
"type": "integer",
"format": "int64",
"description": "The updated-on date in the `int64` format\n"
},
"errorCount": {
"type": "integer",
"format": "int32",
"description": "The failed record count\n"
},
"batchSentCount": {
"type": "integer",
"format": "int32",
"description": "The batch count sent for execution\n"
},
"createdOnReadable": {
"type": "string",
"format": "datetime",
"description": "The created-on date in the `datetime` format\n"
},
"updatedByUsername": {
"type": "string",
"description": "The user who performs the booking date backfill job\n"
},
"updatedOnReadable": {
"type": "string",
"format": "datetime",
"description": "The updated-on date in the `datetime` format\n"
},
"batchFinishedCount": {
"type": "integer",
"format": "int32",
"description": "The finished batch count\n"
}
}
}
GETBulkpdfGenerationJobResponseType
{
"type": "object",
"example": {
"jobId": "402880de8ce7edc3018ce7f18404312a",
"status": "Completed",
"jobName": "BulkPDFGenerationJobV1",
"success": true,
"fileUrls": [
"https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_1.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99",
"https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_2.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99"
],
"createdBy": "caf630704a6f4100818601625ecffe0b",
"createdOn": "2024-01-08 12:52:05",
"stepStatus": "PostProcessing"
},
"properties": {
"jobId": {
"type": "string",
"description": "Unique Id for the Triggered Job"
},
"status": {
"enum": [
"Submitted",
"Executing",
"Completed",
"Error",
"Aborted",
"Cancelled"
],
"type": "string",
"description": "Status of the job"
},
"jobName": {
"type": "string",
"description": "Name of the Job provided during the POST request of the Job"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"fileUrls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Collection of S3 Pre-Signed URL(s) that can be downloaded"
},
"createdBy": {
"type": "string",
"description": "Id of the user who created the job"
},
"createdOn": {
"type": "string",
"description": "Job Created Time"
},
"stepStatus": {
"enum": [
"JobCreated",
"TasksCreated",
"GenerateMissPDF",
"PdfToZip",
"PostProcessing"
],
"type": "string",
"description": "Status of the Current Step that the Job is undergoing"
}
}
}
GETCMTaxItemType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the taxation item.\n"
},
"name": {
"type": "string",
"description": "The name of the taxation item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific credit memo.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date that the tax is applied to the credit memo, in `yyyy-mm-dd` format.\n"
},
"taxRate": {
"type": "number",
"format": "double",
"description": "The tax rate applied to the credit memo.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of taxation.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate.\n"
},
"exemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field.\n"
},
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the refund on the taxation item.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the taxation item.\n"
},
"sourceTaxItemId": {
"type": "string",
"description": "The ID of the source taxation item.\n"
},
"unappliedAmount": {
"type": "number",
"format": "double",
"description": "The unapplied amount of the taxation item.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"onAccountAccountingCode": {
"type": "string",
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"onAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to an on account in your accounting system.\n"
},
"salesTaxPayableAccountingCode": {
"type": "string",
"description": "The accounting code for the sales taxes payable.\n"
},
"salesTaxPayableAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the sales taxes payable.\n"
}
},
"description": "Container for the finance information related to the taxation item.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
}
}
},
{
"$ref": "#/components/schemas/CreditTaxationItemObjectCustomFields"
}
],
"title": "creditTaxItems"
}
GETCMTaxItemTypeNew
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the taxation item.\n"
},
"name": {
"type": "string",
"description": "The name of the taxation item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific credit memo.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date that the tax is applied to the credit memo, in `yyyy-mm-dd` format.\n"
},
"taxRate": {
"type": "number",
"format": "double",
"description": "The tax rate applied to the credit memo.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of taxation.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate.\n"
},
"exemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field.\n"
},
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the refund on the taxation item.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the taxation item.\n"
},
"sourceTaxItemId": {
"type": "string",
"description": "The ID of the source taxation item.\n"
},
"unappliedAmount": {
"type": "number",
"format": "double",
"description": "The unapplied amount of the taxation item.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"onAccountAccountingCode": {
"type": "string",
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"onAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to an on account in your accounting system.\n"
},
"salesTaxPayableAccountingCode": {
"type": "string",
"description": "The accounting code for the sales taxes payable.\n"
},
"salesTaxPayableAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the sales taxes payable.\n"
}
},
"description": "Container for the finance information related to the taxation item.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
}
}
},
{
"$ref": "#/components/schemas/CreditTaxationItemObjectCustomFields"
}
],
"title": "data"
}
GETCalloutHistoryVOType
{
"type": "object",
"title": "calloutHistories",
"properties": {
"createTime": {
"type": "string",
"description": "The time that the calloutHistory record was made.\n"
},
"requestUrl": {
"type": "string",
"description": "The base url set in notifications settings.\n"
},
"attemptedNum": {
"type": "string",
"description": "The number of times the callout was retried.\n"
},
"eventContext": {
"type": "string",
"description": "The context of the callout event.\n"
},
"notification": {
"type": "string",
"description": "The name of the notification.\n"
},
"responseCode": {
"type": "string",
"description": "The responseCode of the request.\n"
},
"eventCategory": {
"type": "string",
"description": "The event category for the callout.\n"
},
"requestMethod": {
"type": "string",
"description": "The request method set in notifications settings.\n"
},
"responseContent": {
"type": "string",
"description": ""
}
}
}
GETCalloutHistoryVOsType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"calloutHistories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETCalloutHistoryVOType"
},
"description": "A container for callout histories.\n"
}
}
}
GETCancelAdjustmentResponseType
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"debitMemoNumber": {
"type": "string",
"description": "The Debit Memo generated to write off the Credit Memo for the delivery adjustment. \n"
}
}
}
]
}
GETCatalogGroupProductRatePlanResponse
{
"type": "object",
"title": "productRatePlans",
"properties": {
"id": {
"type": "string",
"description": "The ID of the product rate plan.\n"
},
"name": {
"type": "string",
"description": "The name of the product rate plan.\n"
},
"grade": {
"type": "number",
"description": "The grade of the product rate plan.\n"
},
"status": {
"enum": [
"Active",
"Expired",
"NotStarted"
],
"type": "string",
"description": "The status of the product rate plan.\n"
},
"description": {
"type": "string",
"description": "The description of the product rate plan.\n"
},
"effectiveEndDate": {
"type": "string",
"description": "The effective end Date of the product rate plan.\n"
},
"effectiveStartDate": {
"type": "string",
"description": "The effective start date of the product rate plan.\n"
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled. \n"
}
}
}
GETCatalogType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETProductType"
},
"description": "Container for one or more products:\n"
}
}
}
GETChargeDefinitionPricingTier
{
"type": "array",
"items": {
"type": "object",
"properties": {
"price": {
"type": "number",
"format": "double",
"description": "The price of the tier if the price format is flat fee, or the price of each unit in the tier if the price format is per unit.\n"
},
"currency": {
"type": "string",
"description": "The code corresponding to the currency for the tier's price.\n"
},
"endingUnit": {
"type": "number",
"format": "double",
"description": "The end number of a range of units for the tier. The field is applicable only for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model.\n"
},
"overagePrice": {
"type": "number",
"format": "double",
"description": "Indicates whether the price is an overage price, which is the price when usage surpasses the last defined tier.\n"
},
"startingUnit": {
"type": "number",
"format": "double",
"description": "The starting number of a range of units for the tier. The field is applicable only for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model.\n"
},
"discountAmount": {
"type": "number",
"format": "double",
"description": "The specific amount for a fixed discount. The field is applicable only for charges based on the Discount-Fixed Amount charge model.\n"
},
"discountPercentage": {
"type": "number",
"format": "double",
"description": "The percentage of discount for a percentage discount. The field is applicable only for charges based on the Discount-Percentage charge model.\n"
}
}
},
"title": "pricingTiers",
"description": "An array of charge pricing tiers.\n"
}
GETContactSnapshotResponse
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the contact snapshot.\n"
},
"fax": {
"type": "string",
"format": "number",
"description": "The fax number of the contact.\n"
},
"city": {
"type": "string",
"description": "The city for the address of the contact.\n"
},
"state": {
"type": "string",
"description": "The state or province for the address of the contact.\n"
},
"county": {
"type": "string",
"description": "The county for the address of the contact. The field value might optionally be used by Zuora Tax to calculate county tax.\n"
},
"country": {
"type": "string",
"description": "The country for the address of the contact.\n"
},
"address1": {
"type": "string",
"description": "The first line for the address of the contact, which is often a street address or business name.\n"
},
"address2": {
"type": "string",
"description": "The second line for the address of the contact, which is mostly the locality.\n"
},
"lastName": {
"type": "string",
"description": "The last name of the contact.\n"
},
"nickname": {
"type": "string",
"description": "A nickname for the contact.\n"
},
"contactId": {
"type": "string",
"description": "The Zuora ID of the contact who the snapshot belongs to.\n"
},
"firstName": {
"type": "string",
"description": "The first name of the contact.\n"
},
"homePhone": {
"type": "string",
"format": "number",
"description": "The home phone number of the contact.\n"
},
"taxRegion": {
"type": "string",
"description": "If using Zuora Tax rules.\n"
},
"workEmail": {
"type": "string",
"description": "The business email address of the contact.\n"
},
"workPhone": {
"type": "string",
"format": "number",
"description": "The business email address of the contact.\n"
},
"otherPhone": {
"type": "string",
"description": "An additional phone number for the contact.\n"
},
"postalCode": {
"type": "string",
"format": "number",
"description": "The postal code for the address of the contact.\n"
},
"description": {
"type": "string",
"description": "A description of the contact.\n"
},
"mobilePhone": {
"type": "string",
"format": "number",
"description": "The mobile phone number of the contact.\n"
},
"personalEmail": {
"type": "string",
"description": "The personal email address of the contact.\n"
},
"otherPhoneType": {
"enum": [
"Work",
"Mobile",
"Home",
"Other"
],
"type": "string",
"description": "The type of the additional phone number.\n"
}
}
},
{
"$ref": "#/components/schemas/ContactSnapshotObjectCustomFields"
}
]
}
GETCreditMemoCollectionType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"creditmemos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETCreditMemoTypewithSuccess"
},
"description": "Container for credit memos.\n"
}
}
}
GETCreditMemoFilesResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"creditMemoFiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoFile"
},
"description": "Container for credit memo PDF files.\n"
}
}
}
GETCreditMemoItemType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the credit memo item.\n"
},
"sku": {
"type": "string",
"description": "The SKU for the product associated with the credit memo item.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax.\n"
},
"comment": {
"type": "string",
"description": "Comments about the credit memo item.\n\n**Note**: This field is not available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"skuName": {
"type": "string",
"description": "The name of the SKU.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive"
],
"type": "string",
"description": "The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax.\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "The number of units for the credit memo item.\n"
},
"unitPrice": {
"type": "number",
"format": "double",
"description": "The per-unit price of the credit memo item.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the credit memo item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"description": {
"type": "string",
"description": "The description of the credit memo item.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the credit memo item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the refund on the credit memo item.\n"
},
"sourceItemId": {
"type": "string",
"description": "The ID of the source item.\n\n- If the value of the `sourceItemType` field is `SubscriptionComponent` , the value of this field is the ID of the corresponding rate plan charge.\n- If the value of the `sourceItemType` field is `InvoiceDetail`, the value of this field is the ID of the corresponding invoice item.\n- If the value of the `sourceItemType` field is `ProductRatePlanCharge` , the value of this field is the ID of the corresponding product rate plan charge.\n- If the value of the `sourceItemType` field is `OrderLineItem` , the value of this field is the ID of the corresponding return order line item.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the credit memo item.\n"
},
"taxationItems": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETCMTaxItemTypeNew"
},
"description": "List of taxation items.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": "Container for the taxation items of the credit memo item. \n\n**Note**: This field is only available if you set the `zuora-version` request header to `239.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"unitOfMeasure": {
"type": "string",
"description": "The units to measure usage.\n"
},
"creditTaxItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETCMTaxItemType"
},
"description": "Container for the taxation items of the credit memo item. \n\n**Note**: This field is not available if you set the `zuora-version` request header to `239.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"processingType": {
"type": "string",
"description": "The kind of the charge for the credit memo item. Its possible values are `Charge` and `Discount`. \n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The service end date of the credit memo item.\n"
},
"sourceItemType": {
"enum": [
"SubscriptionComponent",
"InvoiceDetail",
"ProductRatePlanCharge",
"OrderLineItem"
],
"type": "string",
"description": "The type of the source item.\n\n- If a credit memo is not created from an invoice or a product rate plan charge or a return order line item,, the value of this field is `SubscriptionComponent`.\n- If a credit memo is created from an invoice, the value of this field is `InvoiceDetail`.\n- If a credit memo is created from a product rate plan charge, the value of this field is `ProductRatePlanCharge`.\n- If a credit memo is created from a return order line item, the value of this field is `OrderLineItem`.\n"
},
"subscriptionId": {
"type": "string",
"description": "The ID of the subscription associated with the credit memo item.\n"
},
"appliedToItemId": {
"type": "string",
"description": "The unique ID of the credit memo item that the discount charge is applied to.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the credit memo item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"unappliedAmount": {
"type": "number",
"format": "double",
"description": "The unapplied amount of the credit memo item.\n"
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "The credit memo item amount excluding tax.\n"
},
"creditFromItemId": {
"type": "string",
"description": "The ID of the credit from item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The service start date of the credit memo item. If the associated charge is a one-time fee, this date is the date of that charge.\n"
},
"invoiceScheduleId": {
"type": "string",
"description": "The ID of the invoice schedule associated with the credit memo item. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"revenueScheduleNumber": {
"type": "string",
"description": "Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, RS-00000001.\n"
},
"onAccountAccountingCode": {
"type": "string",
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"onAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to an on account in your accounting system.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n"
},
"deferredRevenueAccountingCodeType": {
"type": "string",
"description": "The type of the deferred revenue accounting code, such as Deferred Revenue.'\n"
},
"recognizedRevenueAccountingCodeType": {
"type": "string",
"description": "The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount.\n"
}
},
"description": "Container for the finance information related to the credit memo item.\n"
},
"numberOfDeliveries": {
"type": "number",
"description": "The number of deliveries dedicated to the Delivery Pricing charges. The value might be different, as follows:\n- For the credit memo generated by a bill run, this field has a value. \n- For the credit memo generated from an invoice, this field is blank.\n**Note**: This field is available only if you have the Delivery Pricing feature enabled. \n"
},
"creditFromItemSource": {
"enum": [
"InvoiceItem",
"CreditMemoItem"
],
"type": "string",
"description": "The type of the credit from item.\n"
},
"invoiceScheduleItemId": {
"type": "string",
"description": "The ID of the invoice schedule item associated with the credit memo item. The credit memo item is generated during the processing of the invoice schedule item.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the credit memo item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the credit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/CreditMemoItemObjectCustomFields"
}
]
}
GETCreditMemoItemTypewithSuccess
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the credit memo item.\n"
},
"sku": {
"type": "string",
"description": "The SKU for the product associated with the credit memo item.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax.\n"
},
"comment": {
"type": "string",
"description": "Comments about the credit memo item.\n\n**Note**: This field is not available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"skuName": {
"type": "string",
"description": "The name of the SKU.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive"
],
"type": "string",
"description": "The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax.\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "The number of units for the credit memo item.\n"
},
"unitPrice": {
"type": "number",
"format": "double",
"description": "The per-unit price of the credit memo item.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the credit memo item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"description": {
"type": "string",
"description": "The description of the credit memo item.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the credit memo item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the refund on the credit memo item.\n"
},
"sourceItemId": {
"type": "string",
"description": "The ID of the source item.\n\n- If the value of the `sourceItemType` field is `SubscriptionComponent` , the value of this field is the ID of the corresponding rate plan charge.\n- If the value of the `sourceItemType` field is `InvoiceDetail`, the value of this field is the ID of the corresponding invoice item.\n- If the value of the `sourceItemType` field is `ProductRatePlanCharge` , the value of this field is the ID of the corresponding product rate plan charge.\n- If the value of the `sourceItemType` field is `OrderLineItem` , the value of this field is the ID of the corresponding return order line item.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the credit memo item.\n"
},
"taxationItems": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETCMTaxItemTypeNew"
},
"description": "List of taxation items.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": "Container for the taxation items of the credit memo item. \n\n**Note**: This field is only available if you set the `zuora-version` request header to `239.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"unitOfMeasure": {
"type": "string",
"description": "The units to measure usage.\n"
},
"creditTaxItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETCMTaxItemType"
},
"description": "Container for the taxation items of the credit memo item. \n\n**Note**: This field is not available if you set the `zuora-version` request header to `239.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"processingType": {
"type": "string",
"description": "The kind of the charge for the credit memo item. Its possible values are `Charge` and `Discount`. \n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The service end date of the credit memo item. \n"
},
"sourceItemType": {
"enum": [
"SubscriptionComponent",
"InvoiceDetail",
"ProductRatePlanCharge",
"OrderLineItem"
],
"type": "string",
"description": "The type of the source item.\n\n- If a credit memo is not created from an invoice or a product rate plan charge or a return order line item, the value of this field is `SubscriptionComponent`. \n- If a credit memo is created from an invoice, the value of this field is `InvoiceDetail`.\n- If a credit memo is created from a product rate plan charge, the value of this field is `ProductRatePlanCharge`.\n- If a credit memo is created from a return order line item, the value of this field is `OrderLineItem`.\n \n"
},
"subscriptionId": {
"type": "string",
"description": "The ID of the subscription associated with the credit memo item.\n"
},
"appliedToItemId": {
"type": "string",
"description": "The unique ID of the credit memo item that the discount charge is applied to.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the credit memo item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"unappliedAmount": {
"type": "number",
"format": "double",
"description": "The unapplied amount of the credit memo item.\n"
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "The credit memo item amount excluding tax.\n"
},
"creditFromItemId": {
"type": "string",
"description": "The ID of the credit from item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The service start date of the credit memo item.\n"
},
"invoiceScheduleId": {
"type": "string",
"description": "The ID of the invoice schedule associated with the credit memo item. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"revenueScheduleNumber": {
"type": "string",
"description": "Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, RS-00000001.\n"
},
"onAccountAccountingCode": {
"type": "string",
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"onAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to an on account in your accounting system.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n"
},
"deferredRevenueAccountingCodeType": {
"type": "string",
"description": "The type of the deferred revenue accounting code, such as Deferred Revenue. \n"
},
"recognizedRevenueAccountingCodeType": {
"type": "string",
"description": "The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount. \n"
}
},
"description": "Container for the finance information related to the credit memo item.\n"
},
"numberOfDeliveries": {
"type": "number",
"description": "The number of deliveries dedicated to the Delivery Pricing charges. The value might be different, as follows:\n- For the credit memo generated by a bill run, this field has a value. \n- For the credit memo generated from an invoice, this field is blank.\n**Note**: This field is available only if you have the Delivery Pricing feature enabled.\n"
},
"creditFromItemSource": {
"enum": [
"InvoiceItem",
"CreditMemoItem"
],
"type": "string",
"description": "The type of the credit from item.\n"
},
"invoiceScheduleItemId": {
"type": "string",
"description": "The ID of the invoice schedule item associated with the credit memo item. The credit memo item is generated during the processing of the invoice schedule item.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the credit memo item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the credit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/CreditMemoItemObjectCustomFields"
}
],
"title": "items"
}
GETCreditMemoItemsListType
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETCreditMemoItemTypewithSuccess"
},
"description": "Container for credit memo items.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
}
}
GETCreditMemoPartType
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the credit memo part.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the credit memo part.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"invoiceId": {
"type": "string",
"description": "The ID of the invoice associated with the credit memo part.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the credit memo part.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"debitMemoId": {
"type": "string",
"description": "The ID of the debit memo associated with the credit memo part.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the credit memo part.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo part was last upated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
}
}
}
GETCreditMemoPartTypewithSuccess
{
"type": "object",
"title": "parts",
"properties": {
"id": {
"type": "string",
"description": "The ID of the credit memo part.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the credit memo part.\n"
},
"invoiceId": {
"type": "string",
"description": "The ID of the invoice associated with the credit memo part.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the credit memo part.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"debitMemoId": {
"type": "string",
"description": "The ID of the debit memo associated with the credit memo part.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the credit memo part.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo part was last upated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
}
}
}
GETCreditMemoPartsCollectionType
{
"type": "object",
"properties": {
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETCreditMemoPartTypewithSuccess"
},
"description": "Container for credit memo parts.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
}
}
GETCreditMemoType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the credit memo.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the credit memo.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the credit memo.\n"
},
"source": {
"type": "string",
"description": "The source of the credit memo.\n\nPossible values:\n- `BillRun`: The credit memo is generated by a bill run.\n- `API`: The credit memo is created by calling the [Invoice and collect](https://developer.zuora.com/api-references/api/operation/POST_TransactionInvoicePayment) operation, or by calling the Orders, Order Line Items, or Fulfillments API operations.\n- `ApiSubscribe`: The credit memo is created by calling the [Create subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription) and [Create account](https://developer.zuora.com/api-references/api/operation/POST_Account) operation.\n- `ApiAmend`: The credit memo is created by calling the [Update subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription) operation.\n- `AdhocFromPrpc`: The credit memo is created from a product rate plan charge through the Zuora UI or by calling the [Create a credit memo from a charge](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc) operation.\n- `AdhocFromInvoice`: The credit memo is created from an invoice or created by reversing an invoice. You can create a credit memo from an invoice through the Zuora UI or by calling the [Create credit memo from invoice](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice) operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the [Reverse invoice](https://developer.zuora.com/api-references/api/operation/PUT_ReverseInvoice) operation.\n"
},
"status": {
"enum": [
"Draft",
"Posted",
"Canceled",
"Error",
"PendingForTax",
"Generating",
"CancelInProgress"
],
"type": "string",
"description": "The status of the credit memo.\n"
},
"comment": {
"type": "string",
"description": "Comments about the credit memo.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"currency": {
"type": "string",
"nullable": true,
"description": "The currency of the credit memo.\n\n**Note:** By default, the currency on a billing document matches the default currency set on the associated account. \nHowever, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. \nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currency</a>.\n"
},
"postedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was posted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"reversed": {
"type": "boolean",
"description": "Whether the credit memo is reversed.\n"
},
"sourceId": {
"type": "string",
"description": "The ID of the credit memo source.\n\nIf a credit memo is generated from a bill run, the value is the number of the corresponding bill run. Otherwise, the value is `null`.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the credit memo.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of taxation.\n"
},
"taxStatus": {
"enum": [
"Complete",
"Error"
],
"type": "string",
"description": "The status of tax calculation related to the credit memo.\n\n**Note**: This field is only applicable to tax calculation by third-party tax engines.\n"
},
"postedById": {
"type": "string",
"description": "The ID of the Zuora user who posted the credit memo.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty.\n"
},
"sourceType": {
"enum": [
"Subscription",
"Standalone",
"Invoice",
"Order",
"CreditMemo",
"Consolidation"
],
"type": "string",
"description": "The type of the credit memo source.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for the credit memo, in `yyyy-mm-dd` format. For example, 2017-07-20.\n"
},
"taxMessage": {
"type": "string",
"description": "The message about the status of tax calculation related to the credit memo. If tax calculation fails in one credit memo, this field displays the reason for the failure.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the credit memo.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the credit memo.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:36:10.\n"
},
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the refund on the credit memo.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account associated with the credit memo.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the credit memo.\n"
},
"cancelledById": {
"type": "string",
"description": "The ID of the Zuora user who cancelled the credit memo.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the credit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"creditMemoDate": {
"type": "string",
"format": "date",
"description": "The date when the credit memo takes effect, in `yyyy-mm-dd` format. For example, 2017-05-20.\n"
},
"einvoiceFileId": {
"type": "string",
"description": "The ID of the e-invoice file generated for the credit memo.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"einvoiceStatus": {
"enum": [
"Processing",
"Generated",
"Success",
"Failed"
],
"type": "string",
"description": "The status of the e-invoice file generation for the credit memo. \n\n- If e-invoice file generation succeeds, this field is either `Generated` or `Success`, and both the error code and message are empty, and the `eInvoiceFileId` field stores the ID of the generated e-invoice file.\n- If a failure occurs during e-invoice file generation, this field is `Failed` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the credit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"latestPDFFileId": {
"type": "string",
"description": "The ID of the latest PDF file generated for the credit memo.\n"
},
"unappliedAmount": {
"type": "number",
"format": "double",
"description": "The unapplied amount of the credit memo.\n"
},
"einvoiceErrorCode": {
"type": "string",
"description": "The error code returned when the e-invoice file status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"referredInvoiceId": {
"type": "string",
"description": "The ID of a referred invoice.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"description": "The number of the invoice group associated with the credit memo.\n\n\nThe value of this field is `null` if you have the [Flexible Billing\nAttributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes)\nfeature disabled.\n"
},
"autoApplyUponPosting": {
"type": "boolean",
"description": "Whether the credit memo automatically applies to the invoice upon posting.\n"
},
"einvoiceErrorMessage": {
"type": "string",
"description": "The error message returned when the e-invoice file status is `Failed`. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"totalTaxExemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot associated with the credit memo.\n\nThe value of this field is `null` if the bill rule [Preserve snapshot of bill-to and sold-to contacts when billing documents are posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted) is disabled.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the credit memo was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite.\n"
},
"excludeFromAutoApplyRules": {
"type": "boolean",
"description": "Whether the credit memo is excluded from the rule of automatically\napplying credit memos to invoices.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the credit memo item from revenue accounting.\n\n\n**Note**: This field is only available if you have the Billing -\nRevenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/CreditMemoObjectNSFields"
},
{
"$ref": "#/components/schemas/CreditMemoObjectCustomFields"
}
]
}
GETCreditMemoTypewithSuccess
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the credit memo.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the credit memo.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the credit memo.\n"
},
"source": {
"type": "string",
"description": "The source of the credit memo.\n\nPossible values:\n- `BillRun`: The credit memo is generated by a bill run.\n- `API`: The credit memo is created by calling the [Invoice and collect](https://developer.zuora.com/api-references/api/operation/POST_TransactionInvoicePayment) operation, or by calling the Orders, Order Line Items, or Fulfillments API operations.\n- `ApiSubscribe`: The credit memo is created by calling the [Create subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription) and [Create account](https://developer.zuora.com/api-references/api/operation/POST_Account) operation.\n- `ApiAmend`: The credit memo is created by calling the [Update subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription) operation.\n- `AdhocFromPrpc`: The credit memo is created from a product rate plan charge through the Zuora UI or by calling the [Create a credit memo from a charge](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc) operation.\n- `AdhocFromInvoice`: The credit memo is created from an invoice or created by reversing an invoice. You can create a credit memo from an invoice through the Zuora UI or by calling the [Create credit memo from invoice](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice) operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the [Reverse invoice](https://developer.zuora.com/api-references/api/operation/PUT_ReverseInvoice) operation.\n"
},
"status": {
"enum": [
"Draft",
"Posted",
"Canceled",
"Error",
"PendingForTax",
"Generating",
"CancelInProgress"
],
"type": "string",
"description": "The status of the credit memo. \n"
},
"comment": {
"type": "string",
"description": "Comments about the credit memo.\n"
},
"currency": {
"type": "string",
"nullable": true,
"description": "The currency of the credit memo.\n\n**Note:** By default, the currency on a billing document matches the default currency set on the associated account. \nHowever, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. \nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currency</a>.\n"
},
"postedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was posted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"reversed": {
"type": "boolean",
"description": "Whether the credit memo is reversed.\n"
},
"sourceId": {
"type": "string",
"description": "The ID of the credit memo source. \n\nIf a credit memo is generated from a bill run, the value is the number of the corresponding bill run. Otherwise, the value is `null`.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the credit memo.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of taxation.\n"
},
"taxStatus": {
"enum": [
"Complete",
"Error"
],
"type": "string",
"description": "The status of tax calculation related to the credit memo.\n\n**Note**: This field is only applicable to tax calculation by third-party tax engines.\n"
},
"postedById": {
"type": "string",
"description": "The ID of the Zuora user who posted the credit memo.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty.\n"
},
"sourceType": {
"enum": [
"Subscription",
"Standalone",
"Invoice",
"Order",
"CreditMemo",
"Consolidation"
],
"type": "string",
"description": "The type of the credit memo source.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for the credit memo, in `yyyy-mm-dd` format. For example, 2017-07-20.\n"
},
"taxMessage": {
"type": "string",
"description": "The message about the status of tax calculation related to the credit memo. If tax calculation fails in one credit memo, this field displays the reason for the failure.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the credit memo.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the credit memo.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the refund on the credit memo.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the account associated with the credit memo.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the credit memo.\n"
},
"cancelledById": {
"type": "string",
"description": "The ID of the Zuora user who cancelled the credit memo.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the credit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"creditMemoDate": {
"type": "string",
"format": "date",
"description": "The date when the credit memo takes effect, in `yyyy-mm-dd` format. For example, 2017-05-20.\n"
},
"einvoiceFileId": {
"type": "string",
"description": "The ID of the e-invoice file generated for the credit memo.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"einvoiceStatus": {
"enum": [
"Processing",
"Generated",
"Success",
"Failed"
],
"type": "string",
"description": "The status of the e-invoice file generation for the credit memo. \n\n- If e-invoice file generation succeeds, this field is either `Generated` or `Success`, and both the error code and message are empty, and the `eInvoiceFileId` field stores the ID of the generated e-invoice file.\n- If a failure occurs during e-invoice file generation, this field is `Failed` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the credit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"latestPDFFileId": {
"type": "string",
"description": "The ID of the latest PDF file generated for the credit memo.\n"
},
"unappliedAmount": {
"type": "number",
"format": "double",
"description": "The unapplied amount of the credit memo.\n"
},
"einvoiceErrorCode": {
"type": "string",
"description": "The error code returned when the e-invoice file status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"referredInvoiceId": {
"type": "string",
"description": "The ID of a referred invoice.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"description": "The number of the invoice group associated with the credit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"autoApplyUponPosting": {
"type": "boolean",
"description": "Whether the credit memo automatically applies to the invoice upon posting.\n"
},
"einvoiceErrorMessage": {
"type": "string",
"description": "The error message returned when the e-invoice file status is `Failed`. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"totalTaxExemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the credit memo was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"excludeFromAutoApplyRules": {
"type": "boolean",
"description": "Whether the credit memo is excluded from the rule of automatically applying unapplied credit memos to invoices and debit memos during payment runs.\n"
}
}
},
{
"$ref": "#/components/schemas/CreditMemoObjectNSFields"
},
{
"$ref": "#/components/schemas/CreditMemoObjectCustomFields"
}
],
"title": "creditmemos"
}
GETCustomExchangeRatesType
{
"type": "object",
"properties": {
"rates": {
"type": "object",
"title": "rates",
"description": "Container for exchange rate data. Contains a set of fields that provide exchange rate data for each day between the specified `startDate` and `endDate` (inclusive). \n",
"additionalProperties": {
"type": "object",
"title": "rate",
"properties": {
"providerExchangeRateDate": {
"type": "string",
"format": "date",
"description": "The date of the exchange rate used. The date is in `yyyy-mm-dd` format.\n\nCorresponds to the value specified in the Provider Exchange Rate Date column in the Import Foreign Exchange Rates template when you uploaded the rates through the Mass Updater.\n"
}
},
"description": "Container for exchange rate information on a given date. The field name is a date in the `yyyy-mm-dd` format. For example, `2024-01-15`.\n",
"additionalProperties": {
"type": "number",
"format": "double",
"description": "The exchange rate on the **providerExchangeRateDate**.\nThe field name is the ISO currency code of the currency, for example, `EUR`. The value is the exchange rate for the specified date, in the format of `0.0000000000`.\n\nThere may be more than one currency returned for a given\n **providerExchangeRateDate**. If the rate for a certain currency is\n not available on the **providerExchangeRateDate**, the currency is not\n returned in the response.\n"
}
}
},
"inverse": {
"type": "boolean",
"description": "- If `true`, the exchange rate in the response is an inverse exchange rate.\n- If `false`, the exchange rate in the response is not an inverse exchange rate.\nThe value is determined by the **Use inverse rate** checkbox in your Zuora Finance Manage Currency Conversion settings.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
}
}
}
GETDMTaxItemType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the taxation item.\n"
},
"name": {
"type": "string",
"description": "The name of the taxation item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific debit memo.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date that the tax is applied to the debit memo, in `yyyy-mm-dd` format.\n"
},
"taxRate": {
"type": "number",
"format": "double",
"description": "The tax rate applied to the debit memo.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of taxation.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate.\n"
},
"creditAmount": {
"type": "number",
"format": "double",
"description": "The amount of credit memos applied to the debit memo. \n"
},
"exemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field.\n"
},
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the refund on the taxation item.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the taxation item.\n"
},
"paymentAmount": {
"type": "number",
"format": "double",
"description": "The amount of payments applied to the debit memo. \n"
},
"sourceTaxItemId": {
"type": "string",
"description": "The ID of the source taxation item.\n"
},
"unappliedAmount": {
"type": "number",
"format": "double",
"description": "The unapplied amount of the taxation item.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"salesTaxPayableAccountingCode": {
"type": "string",
"description": "The accounting code for the sales taxes payable.\n"
},
"salesTaxPayableAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the sales taxes payable.\n"
}
},
"description": "Container for the finance information related to the taxation item.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
}
}
},
{
"$ref": "#/components/schemas/DebitTaxationItemObjectCustomFields"
}
],
"title": "taxItems"
}
GETDMTaxItemTypeNew
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the taxation item.\n"
},
"name": {
"type": "string",
"description": "The name of the taxation item.\n"
},
"balance": {
"type": "number",
"format": "double",
"description": "The balance of the taxation item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific debit memo.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date that the tax is applied to the debit memo, in `yyyy-mm-dd` format.\n"
},
"taxRate": {
"type": "number",
"format": "double",
"description": "The tax rate applied to the debit memo.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of taxation.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate.\n"
},
"creditAmount": {
"type": "number",
"format": "double",
"description": "The amount of credit memos applied to the debit memo. \n"
},
"exemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field.\n"
},
"paymentAmount": {
"type": "number",
"format": "double",
"description": "The amount of payments applied to the debit memo. \n"
},
"sourceTaxItemId": {
"type": "string",
"description": "The ID of the source taxation item.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"salesTaxPayableAccountingCode": {
"type": "string",
"description": "The accounting code for the sales taxes payable.\n"
},
"salesTaxPayableAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the sales taxes payable.\n"
}
},
"description": "Container for the finance information related to the taxation item.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
}
}
},
{
"$ref": "#/components/schemas/DebitTaxationItemObjectCustomFields"
}
],
"title": "data"
}
GETDebitMemoCollectionType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"debitmemos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETDebitMemoTypewithSuccess"
},
"description": "Container for debit memos.\n"
}
}
}
GETDebitMemoFilesResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"debitMemoFiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DebitMemoFile"
},
"description": "Container for debit memo PDF files.\n"
}
}
}
GETDebitMemoItemCollectionType
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETDebitMemoItemTypewithSuccess"
},
"description": "Container for debit memo items.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
}
}
GETDebitMemoItemType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the debit memo item.\n"
},
"sku": {
"type": "string",
"description": "The SKU for the product associated with the debit memo item.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax.\n"
},
"balance": {
"type": "number",
"format": "double",
"description": "The balance of the debit memo item.\n"
},
"comment": {
"type": "string",
"description": "Comments about the debit memo item.\n\n**Note**: This field is not available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"skuName": {
"type": "string",
"description": "The name of the SKU.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive"
],
"type": "string",
"description": "The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax.\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "The number of units for the debit memo item.\n"
},
"taxItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETDMTaxItemType"
},
"description": "Container for the taxation items of the debit memo item.. \n\n**Note**: This field is not available if you set the `zuora-version` request header to `239.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"unitPrice": {
"type": "number",
"format": "double",
"description": "The per-unit price of the debit memo item.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the debit memo item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"description": {
"type": "string",
"description": "Description about the debit memo item.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the debit memo item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"sourceItemId": {
"type": "string",
"description": "The ID of the source item.\n"
},
"taxationItems": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETDMTaxItemTypeNew"
},
"description": "List of taxation items.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": "Container for the taxation items of the debit memo item.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `239.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"unitOfMeasure": {
"type": "string",
"description": "The units to measure usage.\n"
},
"processingType": {
"type": "string",
"description": "The kind of the charge for the debit memo item. Its possible values are `Charge` and `Discount`. \n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The end date of the service period associated with this debit memo item. Service ends one second before the date specified in this field.\n"
},
"sourceItemType": {
"enum": [
"CreditMemoItem",
"SubscriptionComponent",
"InvoiceDetail",
"ProductRatePlanCharge"
],
"type": "string",
"description": "The type of the source item.\n"
},
"subscriptionId": {
"type": "string",
"description": "The ID of the subscription associated with the debit memo item.\n"
},
"appliedToItemId": {
"type": "string",
"description": "The parent debit memo item that this debit memo items is applied to if this item is discount.\n"
},
"beAppliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the debit memo item.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the invoice item.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "The debit memo item amount excluding tax.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The start date of the service period associated with this debit memo item. If the associated charge is a one-time fee, this date is the date of that charge.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"revenueScheduleNumber": {
"type": "string",
"description": "The revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, RS-00000001.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n"
},
"deferredRevenueAccountingCodeType": {
"type": "string",
"description": "The type of the deferred revenue accounting code, such as Deferred Revenue.\n"
},
"recognizedRevenueAccountingCodeType": {
"type": "string",
"description": "The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount.\n"
}
},
"description": "Container for the finance information related to the debit memo item.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the invoice item.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. \n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the debit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/DebitMemoItemObjectCustomFields"
}
]
}
GETDebitMemoItemTypewithSuccess
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the debit memo item.\n"
},
"sku": {
"type": "string",
"description": "The SKU for the product associated with the debit memo item.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax.\n"
},
"balance": {
"type": "number",
"format": "double",
"description": "The balance of the debit memo item.\n"
},
"comment": {
"type": "string",
"description": "Comments about the debit memo item.\n\n**Note**: This field is not available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"skuName": {
"type": "string",
"description": "The name of the SKU.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive"
],
"type": "string",
"description": "The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax.\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "The number of units for the debit memo item.\n"
},
"taxItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETDMTaxItemType"
},
"description": "Container for the taxation items of the debit memo item. \n\n**Note**: This field is not available if you set the `zuora-version` request header to `239.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"unitPrice": {
"type": "number",
"format": "double",
"description": "The per-unit price of the debit memo item.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the debit memo item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"description": {
"type": "string",
"description": "The description of the debit memo item.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the debit memo item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"sourceItemId": {
"type": "string",
"description": "The ID of the source item.\n"
},
"taxationItems": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETDMTaxItemTypeNew"
},
"description": "List of taxation items.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": "Container for the taxation items of the debit memo item. \n\n**Note**: This field is only available if you set the `zuora-version` request header to `239.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"unitOfMeasure": {
"type": "string",
"description": "The units to measure usage.\n"
},
"processingType": {
"type": "string",
"description": "The kind of the charge for the debit memo item. Its possible values are `Charge` and `Discount`. \n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The end date of the service period associated with this debit memo item. Service ends one second before the date specified in this field.\n"
},
"sourceItemType": {
"enum": [
"CreditMemoItem",
"SubscriptionComponent",
"InvoiceDetail",
"ProductRatePlanCharge"
],
"type": "string",
"description": "The type of the source item.\n"
},
"subscriptionId": {
"type": "string",
"description": "The ID of the subscription associated with the debit memo item.\n"
},
"appliedToItemId": {
"type": "string",
"description": "The parent debit memo item that this debit memo items is applied to if this item is discount.\n"
},
"beAppliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the debit memo item.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the invoice item.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "The debit memo item amount excluding tax.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The start date of the service period associated with this debit memo item. If the associated charge is a one-time fee, this date is the date of that charge.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"revenueScheduleNumber": {
"type": "string",
"description": "The revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, RS-00000001.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n"
},
"deferredRevenueAccountingCodeType": {
"type": "string",
"description": "The type of the deferred revenue accounting code, such as Deferred Revenue.\n"
},
"recognizedRevenueAccountingCodeType": {
"type": "string",
"description": "The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount.\n"
}
},
"description": "Container for the finance information related to the debit memo item.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the invoice item.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. \n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the debit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/DebitMemoItemObjectCustomFields"
}
],
"title": "items"
}
GETDebitMemoType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the debit memo.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the debit memo.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the debit memo.\n"
},
"status": {
"enum": [
"Draft",
"Posted",
"Canceled",
"Error",
"PendingForTax",
"Generating",
"CancelInProgress"
],
"type": "string",
"description": "The status of the debit memo.\n"
},
"autoPay": {
"type": "boolean",
"description": "Whether debit memos are automatically picked up for processing in the corresponding payment run.\n\nBy default, debit memos are automatically picked up for processing in the corresponding payment run.\n"
},
"balance": {
"type": "number",
"format": "double",
"description": "The balance of the debit memo.\n"
},
"comment": {
"type": "string",
"description": "Comments about the debit memo.\n"
},
"dueDate": {
"type": "string",
"format": "date",
"description": "The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"currency": {
"type": "string",
"nullable": true,
"description": "The currency of the debit memo.\n\n**Note:** By default, the currency on a billing document matches the default currency set on the associated account. \nHowever, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. \nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currency</a>.\n"
},
"postedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was posted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the debit memo.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of taxation.\n"
},
"taxStatus": {
"enum": [
"Complete",
"Error"
],
"type": "string",
"description": "The status of tax calculation related to the debit memo.\n\n**Note**: This field is only applicable to tax calculation by third-party tax engines.\n"
},
"postedById": {
"type": "string",
"description": "The ID of the Zuora user who posted the debit memo.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty.\n"
},
"sourceType": {
"enum": [
"Subscription",
"Standalone",
"Order",
"Consolidation",
"Invoice",
"CreditMemo"
],
"type": "string",
"description": "The type of the debit memo source.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for the debit memo, in `yyyy-mm-dd` format. For example, 2017-07-20.\n"
},
"taxMessage": {
"type": "string",
"description": "The message about the status of tax calculation related to the debit memo. If tax calculation fails in one debit memo, this field displays the reason for the failure.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the debit memo.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"paymentTerm": {
"type": "string",
"description": "The name of the payment term assoicated with the debit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the debit memo.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account associated with the debit memo. \n"
},
"cancelledById": {
"type": "string",
"description": "The ID of the Zuora user who cancelled the debit memo.\n"
},
"debitMemoDate": {
"type": "string",
"format": "date",
"description": "The date when the debit memo takes effect, in `yyyy-mm-dd` format. For example, 2017-05-20.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the debit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n \n"
},
"einvoiceFileId": {
"type": "string",
"description": "The ID of the e-invoice file generated for the debit memo.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"einvoiceStatus": {
"enum": [
"Processing",
"Generated",
"Success",
"Failed"
],
"type": "string",
"description": "The status of the e-invoice file generation for the debit memo. \n\n- If e-invoice file generation succeeds, this field is either `Generated` or `Success`, and both the error code and message are empty, and the `eInvoiceFileId` field stores the ID of the generated e-invoice file.\n- If a failure occurs during e-invoice file generation, this field is `Failed` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"beAppliedAmount": {
"type": "number",
"format": "double",
"description": "The amount that is applied to the debit memo.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the debit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"latestPDFFileId": {
"type": "string",
"description": "The ID of the latest PDF file generated for the debit memo.\n"
},
"einvoiceErrorCode": {
"type": "string",
"description": "The error code returned when the e-invoice file status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"referredInvoiceId": {
"type": "string",
"description": "The ID of a referred invoice.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"description": "The number of the invoice group associated with the debit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"einvoiceErrorMessage": {
"type": "string",
"description": "The error message returned when the e-invoice file status is `Failed`. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"referredCreditMemoId": {
"type": "string",
"description": "The ID of the credit memo from which the debit memo was created.\n"
},
"totalTaxExemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot associated with the debit memo.\n\nThe value of this field is `null` if the bill rule [Preserve snapshot of bill-to and sold-to contacts when billing documents are posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted) is disabled.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the debit memo was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the debit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/DebitMemoObjectNSFields"
},
{
"$ref": "#/components/schemas/DebitMemoObjectCustomFields"
}
],
"title": "memos"
}
GETDebitMemoTypewithSuccess
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the debit memo.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the debit memo.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the debit memo.\n"
},
"status": {
"enum": [
"Draft",
"Posted",
"Canceled",
"Error",
"PendingForTax",
"Generating",
"CancelInProgress"
],
"type": "string",
"description": "The status of the debit memo. \n"
},
"autoPay": {
"type": "boolean",
"description": "Whether debit memos are automatically picked up for processing in the corresponding payment run. \n\nBy default, debit memos are automatically picked up for processing in the corresponding payment run. \n"
},
"balance": {
"type": "number",
"format": "double",
"description": "The balance of the debit memo.\n"
},
"comment": {
"type": "string",
"description": "Comments about the debit memo.\n"
},
"dueDate": {
"type": "string",
"format": "date",
"description": "The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format.\n"
},
"currency": {
"type": "string",
"nullable": true,
"description": "The currency of the debit memo.\n\n**Note:** By default, the currency on a billing document matches the default currency set on the associated account. \nHowever, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. \nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currency</a>.\n"
},
"postedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was posted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the debit memo.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of taxation.\n"
},
"taxStatus": {
"enum": [
"Complete",
"Error"
],
"type": "string",
"description": "The status of tax calculation related to the debit memo.\n\n**Note**: This field is only applicable to tax calculation by third-party tax engines.\n"
},
"postedById": {
"type": "string",
"description": "The ID of the Zuora user who posted the debit memo.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty.\n"
},
"sourceType": {
"enum": [
"Subscription",
"Standalone",
"Order",
"Consolidation",
"Invoice",
"CreditMemo"
],
"type": "string",
"description": "The type of the debit memo source.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for the debit memo, in `yyyy-mm-dd` format. For example, 2017-07-20.\n"
},
"taxMessage": {
"type": "string",
"description": "The message about the status of tax calculation related to the debit memo. If tax calculation fails in one debit memo, this field displays the reason for the failure.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the debit memo.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"paymentTerm": {
"type": "string",
"description": "The name of the payment term associated with the debit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the debit memo.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:31:10.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account associated with the debit memo.\n"
},
"cancelledById": {
"type": "string",
"description": "The ID of the Zuora user who cancelled the debit memo.\n"
},
"debitMemoDate": {
"type": "string",
"format": "date",
"description": "The date when the debit memo takes effect, in `yyyy-mm-dd` format. For example, 2017-05-20.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the debit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"einvoiceFileId": {
"type": "string",
"description": "The ID of the e-invoice file generated for the debit memo.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"einvoiceStatus": {
"enum": [
"Processing",
"Generated",
"Success",
"Failed"
],
"type": "string",
"description": "The status of the e-invoice file generation for the debit memo. \n\n- If e-invoice file generation succeeds, this field is either `Generated` or `Success`, and both the error code and message are empty, and the `eInvoiceFileId` field stores the ID of the generated e-invoice file.\n- If a failure occurs during e-invoice file generation, this field is `Failed` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"beAppliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the debit memo.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the debit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"latestPDFFileId": {
"type": "string",
"description": "The ID of the latest PDF file generated for the debit memo.\n"
},
"einvoiceErrorCode": {
"type": "string",
"description": "The error code returned when the e-invoice file status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"referredInvoiceId": {
"type": "string",
"description": "The ID of a referred invoice.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"description": "The number of the invoice group associated with the debit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"einvoiceErrorMessage": {
"type": "string",
"description": "The error message returned when the e-invoice file status is `Failed`. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"referredCreditMemoId": {
"type": "string",
"description": "The ID of the credit memo from which the debit memo was created.\n"
},
"totalTaxExemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the debit memo was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
}
}
},
{
"$ref": "#/components/schemas/DebitMemoObjectNSFields"
},
{
"$ref": "#/components/schemas/DebitMemoObjectCustomFields"
}
],
"title": "debitmemos"
}
GETDeliverySchedule
{
"type": "object",
"title": "deliverySchedule",
"nullable": true,
"properties": {
"friday": {
"type": "boolean",
"description": "The flag to indicate whether the delivery happens on Friday.\n"
},
"monday": {
"type": "boolean",
"description": "The flag to indicate whether the delivery happens on Monday.\n"
},
"sunday": {
"type": "boolean",
"description": "The flag to indicate whether the delivery happens on Sunday.\n"
},
"tuesday": {
"type": "boolean",
"description": "The flag to indicate whether the delivery happens on Tuesday.\n"
},
"saturday": {
"type": "boolean",
"description": "The flag to indicate whether the delivery happens on Saturday.\n"
},
"thursday": {
"type": "boolean",
"description": "The flag to indicate whether the delivery happens on Thursday.\n"
},
"frequency": {
"enum": [
"Weekly"
],
"type": "string",
"description": "The frequency of the delivery. Only weekly delivery is supported now.\n"
},
"wednesday": {
"type": "boolean",
"description": "The flag to indicate whether the delivery happens on Wendesday.\n"
}
}
}
GETDeliveryScheduleType
{
"type": "object",
"title": "deliverySchedule",
"properties": {
"friday": {
"type": "boolean",
"description": "Indicates whether delivery occurs on Friday.\n"
},
"monday": {
"type": "boolean",
"description": "Indicates whether delivery occurs on Monday.\n"
},
"sunday": {
"type": "boolean",
"description": "Indicates whether delivery occurs on Sunday.\n"
},
"tuesday": {
"type": "boolean",
"description": "Indicates whether delivery occurs on Tuesday.\n"
},
"saturday": {
"type": "boolean",
"description": "Indicates whether delivery occurs on Saturday.\n"
},
"thursday": {
"type": "boolean",
"description": "Indicates whether delivery occurs on Thursday.\n"
},
"frequency": {
"enum": [
"Weekly"
],
"type": "string",
"description": "Specifies delivery frequency for the delivery schedule.\n"
},
"wednesday": {
"type": "boolean",
"description": "Indicates whether delivery occurs on Wednesday.\n"
}
},
"description": "The `deliverySchedule` is used for the Delivery Pricing charge model only. \n\n**Note**: The Delivery Pricing charge model 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. You can check **Delivery Pricing** in **Billing Settings** > **Enable Charge Types / Models**.\n"
}
GETDiscountApplyDetailsType
{
"type": "object",
"title": "discountApplyDetails",
"properties": {
"appliedProductName": {
"type": "string",
"description": "The name of the product that the discount rate plan charge applies to.\n"
},
"appliedProductRatePlanId": {
"type": "string",
"description": "The ID of the product rate plan that the discount rate plan charge applies to.\n"
},
"appliedProductRatePlanName": {
"type": "string",
"description": "The name of the product rate plan that the discount rate plan charge applies to.\n"
},
"appliedProductRatePlanChargeId": {
"type": "string",
"description": "The ID of the product rate plan charge that the discount rate plan charge applies to.\n"
},
"appliedProductRatePlanChargeName": {
"type": "string",
"description": "The name of the product rate plan charge that the discount rate plan charge applies to.\n"
}
}
}
GETEmailHistoryVOType
{
"type": "object",
"title": "emailHistories",
"properties": {
"cc": {
"type": "string",
"description": "Carbon Copy recipients of the email.\n"
},
"bcc": {
"type": "string",
"description": "Blind carbon copy recipients of the email.\n"
},
"result": {
"type": "string",
"description": "The result from the mail server of sending the email.\n"
},
"replyTo": {
"type": "string",
"description": "The reply-to address as configured in the email template.\n"
},
"subject": {
"type": "string",
"description": "The subject of the email.\n"
},
"toEmail": {
"type": "string",
"description": "The intended recipient of the email.\n"
},
"sendTime": {
"type": "string",
"description": "The date and time the email was sent.\n"
},
"accountId": {
"type": "string",
"description": "ID of an account.\n"
},
"fromEmail": {
"type": "string",
"description": "The sender of the email.\n"
},
"errorMessage": {
"type": "string",
"description": "null if the content of result is \"OK\". A description of the error if the content of result is not \"OK\".\n"
},
"notification": {
"type": "string",
"description": "The name of the notification.\n"
},
"eventCategory": {
"type": "string",
"description": "The event category of the email.\n"
}
}
}
GETEmailHistoryVOsType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"emailHistories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETEmailHistoryVOType"
},
"description": "A container for email histories.\n"
}
}
}
GETIntervalPriceTierType
{
"type": "object",
"title": "IntervalPricing",
"properties": {
"tier": {
"type": "integer",
"format": "int64",
"description": "Unique number of the tier.\n"
},
"price": {
"type": "number",
"description": "The decimal value of the tiered charge model. If the charge model is not a tiered type then this price field will be null and the `price` field directly under the `productRatePlanCharges` applies.\n"
},
"endingUnit": {
"type": "number",
"description": "Decimal defining end of tier range.\n"
},
"priceFormat": {
"type": "string",
"description": "Tier price format. Allowed values: `flat fee`, `per unit`.\n"
},
"startingUnit": {
"type": "number",
"description": "Decimal defining start of tier range.\n"
},
"isOveragePrice": {
"type": "boolean",
"description": "True if the price is overage price for the tier.\n"
}
}
}
GETIntervalPriceType
{
"type": "object",
"title": "IntervalPricing",
"properties": {
"type": {
"enum": [
"Day",
"Month",
"Infinity"
],
"type": "string",
"description": "Interval type of this pricing.\n"
},
"price": {
"type": "number",
"description": "Price of this interval.\n"
},
"duration": {
"type": "integer",
"description": "Duration period of this interval.\n"
},
"sequence": {
"type": "integer",
"description": "A system-generated number that indicates the sequence in which each interval price is billed.\n"
},
"subscriptionChargeIntervalPriceTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETIntervalPriceTierType"
}
}
}
}
GETInvoiceFilesResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"invoiceFiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceFile"
},
"description": "Container for invoice PDF files.\n"
}
}
}
GETInvoiceItemsResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceItem"
},
"description": "Container for invoice items.\n"
}
}
}
GETInvoiceTaxItemType
{
"allOf": [
{
"$ref": "#/components/schemas/TaxationItemObjectCustomFields"
},
{
"type": "object",
"title": "data",
"properties": {
"id": {
"type": "string",
"description": "The ID of the taxation item.\n"
},
"name": {
"type": "string",
"description": "The name of the taxation item.\n"
},
"balance": {
"type": "number",
"format": "double",
"description": "The balance of the taxation item.\n"
},
"country": {
"type": "string",
"description": "The field which contains country code.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific invoice.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date that the tax is applied to the invoice, in `yyyy-mm-dd` format.\n"
},
"taxRate": {
"type": "number",
"format": "double",
"description": "The tax rate applied to the invoice.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of taxation.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate.\n"
},
"creditAmount": {
"type": "number",
"format": "double",
"description": "The amount of credit memos applied to the taxation item. \n"
},
"exemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field.\n"
},
"paymentAmount": {
"type": "number",
"format": "double",
"description": "The amount of payments applied to the taxation item. \n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
},
"applicableTaxUnRounded": {
"type": "number",
"description": "The unrounded amount of the tax. \n"
},
"availableToCreditAmount": {
"type": "number",
"format": "decimal",
"description": "The amount of the invoice taxation item that is available to credit.\n"
}
}
}
],
"title": "data"
}
GETInvoiceTaxationItemsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETInvoiceTaxItemType"
},
"description": "Container for the taxation items of the invoice item.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
}
}
GETJournalEntriesInJournalRunType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"journalEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETJournalEntryDetailTypeWithoutSuccess"
},
"description": "Key name that represents the list of journal entries.\n"
}
}
}
GETJournalEntryDetailType
{
"allOf": [
{
"type": "object",
"properties": {
"notes": {
"type": "string",
"description": "\nAdditional information about this record.\nCharacter limit: 2,000\n"
},
"number": {
"type": "string",
"description": "Journal entry number in the format JE-00000001.\n"
},
"status": {
"enum": [
"Created",
"Cancelled"
],
"type": "string",
"description": "Status of journal entry.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"currency": {
"type": "string",
"description": "Currency used.\n"
},
"segments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETJournalEntrySegmentType"
},
"description": "List of segments that apply to the summary journal entry.\n"
},
"homeCurrency": {
"type": "string",
"description": "Home currency used.\n"
},
"timePeriodEnd": {
"type": "string",
"format": "date",
"description": "End date of time period included in the journal entry.\n"
},
"transferredBy": {
"type": "string",
"description": "User ID of the person who changed transferredToAccounting to `Yes`. This field is returned only when transferredToAccounting is `Yes`. Otherwise, this field is `null`.\n"
},
"timePeriodStart": {
"type": "string",
"format": "date",
"description": "Start date of time period included in the journal entry.\n"
},
"transactionType": {
"type": "string",
"description": "Transaction type of the transactions included in the summary journal entry.\n"
},
"journalEntryDate": {
"type": "string",
"format": "date",
"description": "Date of the journal entry.\n"
},
"transferDateTime": {
"type": "string",
"format": "date-time",
"description": "Date and time that transferredToAccounting was changed to `Yes`. This field is returned only when transferredToAccounting is `Yes`. Otherwise, this field is `null`.\n"
},
"aggregateCurrency": {
"type": "boolean",
"description": "Returns true if the journal entry is aggregating currencies. That is, if the journal entry was created when the `Aggregate transactions with different currencies during a Journal Run` setting was configured to `Yes`. Otherwise, returns `false`.\n"
},
"journalEntryItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETJournalEntryItemType"
},
"description": "Key name that represents the list of journal entry items.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"accountingPeriodName": {
"type": "string",
"description": "Name of the accounting period that the journal entry belongs to.\n"
},
"transferredToAccounting": {
"enum": [
"No",
"Processing",
"Yes",
"Error",
"Ignore"
],
"type": "string",
"description": "Status shows whether the journal entry has been transferred to an accounting system. "
}
}
},
{
"$ref": "#/components/schemas/JournalEntryObjectCustomFields"
}
]
}
GETJournalEntryDetailTypeWithoutSuccess
{
"allOf": [
{
"type": "object",
"properties": {
"notes": {
"type": "string",
"description": "Additional information about this record.\nCharacter limit: 2,000\n"
},
"number": {
"type": "string",
"description": "Journal entry number in the format JE-00000001.\n"
},
"status": {
"enum": [
"Created",
"Cancelled"
],
"type": "string",
"description": "Status of journal entry. "
},
"currency": {
"type": "string",
"description": "Currency used.\n"
},
"segments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETJournalEntrySegmentType"
},
"description": "List of segments that apply to the summary journal entry.\n"
},
"homeCurrency": {
"type": "string",
"description": "Home currency used.\n"
},
"timePeriodEnd": {
"type": "string",
"format": "date",
"description": "End date of time period included in the journal entry.\n"
},
"transferredBy": {
"type": "string",
"description": "User ID of the person who changed transferredToAccounting to `Yes`. This field is returned only when transferredToAccounting is `Yes`. Otherwise, this field is `null`.\n"
},
"timePeriodStart": {
"type": "string",
"format": "date",
"description": "Start date of time period included in the journal entry.\n"
},
"transactionType": {
"type": "string",
"description": "Transaction type of the transactions included in the summary journal entry.\n"
},
"journalEntryDate": {
"type": "string",
"format": "date",
"description": "Date of the journal entry.\n"
},
"transferDateTime": {
"type": "string",
"format": "date-time",
"description": "Date and time that transferredToAccounting was changed to `Yes`. This field is returned only when transferredToAccounting is `Yes`. Otherwise, this field is `null`.\n"
},
"aggregateCurrency": {
"type": "boolean",
"description": "Returns true if the journal entry is aggregating currencies. That is, if the journal entry was created when the `Aggregate transactions with different currencies during a JournalRun` setting was configured to \"Yes\". Otherwise, returns `false`.\n"
},
"journalEntryItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETJournalEntryItemType"
},
"description": "Key name that represents the list of journal entry items.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"accountingPeriodName": {
"type": "string",
"description": "Name of the accounting period that the journal entry belongs to.\n"
},
"transferredToAccounting": {
"enum": [
"No",
"Processing",
"Yes",
"Error",
"Ignore"
],
"type": "string",
"description": "Status shows whether the journal entry has been transferred to an accounting system. "
}
}
},
{
"$ref": "#/components/schemas/JournalEntryObjectCustomFields"
}
],
"title": "journalEntries"
}
GETJournalEntryItemType
{
"allOf": [
{
"type": "object",
"properties": {
"type": {
"enum": [
"Credit",
"Debit"
],
"type": "string",
"description": "Type of journal entry item. "
},
"amount": {
"type": "string",
"format": "decimal",
"description": "Journal entry item amount in transaction currency.\n"
},
"glAccountName": {
"type": "string",
"description": "The account number in the general ledger (GL) that corresponds to the accounting code.\n"
},
"glAccountNumber": {
"type": "string",
"description": "The account name in the general ledger (GL) that corresponds to the accounting code.\n"
},
"accountingCodeName": {
"type": "string",
"description": "Name of the accounting code.\n"
},
"accountingCodeType": {
"enum": [
"AccountsReceivable",
"On-Account Receivable",
"Cash",
"OtherAssets",
"CustomerCashOnAccount",
"DeferredRevenue",
"SalesTaxPayable",
"OtherLiabilities",
"SalesRevenue",
"SalesDiscounts",
"OtherRevenue",
"OtherEquity",
"BadDebt",
"OtherExpenses"
],
"type": "string",
"description": "Accounting code type.\n\nNote that `On-Account Receivable` is only available if you enable the Invoice Settlement feature. \n"
},
"homeCurrencyAmount": {
"type": "string",
"format": "decimal",
"description": "Journal entry item amount in home currency.\n"
}
}
},
{
"$ref": "#/components/schemas/JournalEntryItemObjectCustomFields"
}
],
"title": "journalEntryItems"
}
GETJournalEntrySegmentType
{
"type": "object",
"title": "segments",
"properties": {
"segmentName": {
"type": "string",
"description": "Name of segment.\n"
},
"segmentValue": {
"type": "string",
"description": "Value of segment in this summary journal entry.\n"
}
}
}
GETJournalRunTransactionType
{
"type": "object",
"title": "transactionTypes",
"properties": {
"type": {
"enum": [
"Invoice Item",
"Taxation Item",
"Invoice Item Adjustment (Invoice)",
"Invoice Item Adjustment (Tax)",
"Invoice Adjustment",
"Electronic Payment",
"External Payment",
"Electronic Refund",
"External Refund",
"Electronic Credit Balance Payment",
"External Credit Balance Payment",
"Electronic Credit Balance Refund",
"External Credit Balance Refund",
"Credit Balance Adjustment (Applied from Credit Balance)",
"Credit Balance Adjustment (Transferred to Credit Balance)",
"Revenue Event Item",
"Debit Memo Item (Charge)",
"Debit Memo Item (Tax)",
"Credit Memo Item (Charge)",
"Credit Memo Item (Tax)",
"Credit Memo Application Item",
"Electronic Payment Application",
"External Payment Application",
"Electronic Refund Application",
"External Refund Application",
"Electronic Payment Application Item",
"External Payment Application Item",
"Electronic Refund Application Item",
"External Refund Application Item"
],
"type": "string",
"description": "Transaction type. Invoice Adjustment is deprecated on Production. Zuora recommends that you use the Invoice Item Adjustment instead.\n\nIf you enable the Invoice Settlement feature, Debit Memo Item, Credit Memo Item, and Credit Memo Application Item are available, Payment and Refund will be replaced by Payment Application and Refund Application. \n\nIf you enable both the Invoice Settlement feature and the Invoice Item Settlement feature, Payment and Refund will be replaced by Payment Application Item and Refund Application Item. \n"
}
}
}
GETJournalRunType
{
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "Journal run number.\n"
},
"status": {
"enum": [
"Pending",
"Processing",
"Completed",
"Error",
"CancelInprogress",
"Cancelled",
"DeleteInprogress"
],
"type": "string",
"description": "Status of the journal run. \n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"executedOn": {
"type": "string",
"format": "date-time",
"description": "Date and time the journal run was executed.\n"
},
"targetEndDate": {
"type": "string",
"format": "date",
"description": "The target end date of the journal run.\n"
},
"targetStartDate": {
"type": "string",
"format": "date",
"description": "The target start date of the journal run.\n"
},
"journalEntryDate": {
"type": "string",
"format": "date",
"description": "Date of the journal entry.\n"
},
"transactionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETJournalRunTransactionType"
},
"description": "Transaction types included in the journal run.\n"
},
"aggregateCurrency": {
"type": "boolean",
"description": ""
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"segmentationRuleName": {
"type": "string",
"description": "Name of GL segmentation rule used in the journal run.\n"
},
"totalJournalEntryCount": {
"type": "integer",
"format": "int64",
"description": "Total number of journal entries in the journal run.\n"
}
}
}
GETListApplePayDomainsResponse
{
"type": "object",
"properties": {
"domains": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"description": "The ID of the domain, such as `402881a38924ff1001892502da090021`.\n"
},
"createdBy": {
"type": "string",
"description": "The ID of the user who created this domain.\n"
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the domain was created, in `yyyy-mm-dd hh:mm:ss` format. \n"
},
"updatedBy": {
"type": "string",
"description": "The ID of the user who made the last update to this domain.\n"
},
"updatedOn": {
"type": "string",
"format": "date-time",
"description": "The last date and time when the domain was updated, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"domainName": {
"type": "string",
"description": "The name of the domain registered with Apple Pay, such as `testapplepay.zuora.com`. \n"
},
"domainVerified": {
"type": "boolean",
"description": "Indicates whether the domain registration is successfully verified. \n"
}
}
},
"description": "Container for domains that are already registered with Apple Pay.\n"
},
"success": {
"type": "boolean",
"description": "Indicates whether this call succeeds.\n"
}
}
}
GETMassUpdateType
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the mass action. The following table describes the mass action statuses.\n\n| Status | Description |\n|------------|----------------------------------------------------------------------------|\n| Pending | Mass action has not yet started being processed. |\n| Processing | Mass action is in progress. |\n| Stopping | Mass action is in the process of stopping, but has not yet stopped. |\n| Stopped | Mass action has stopped. |\n| Completed | Mass action was successfully completed. There may still be failed records. |\n| Failed | Mass action failed. No records are processed. No response file is created. |\n"
},
"endedOn": {
"type": "string",
"format": "date-time",
"description": "Date and time that the mass action was completed. The format is `yyyy-MM-dd hh:mm:ss`.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"inputSize": {
"type": "integer",
"format": "int64",
"description": "Size of the input file in bytes.\n"
},
"outputURL": {
"type": "string",
"description": "URL to download the response file. The response file is a zipped .csv file. \nThe response file is identical to the file you uploaded to perform the mass action, with additional columns providing information about the outcome of each record. \nThis field only returns a value when the mass action **status** is Completed or Stopped. Otherwise, this field is null.\n"
},
"startedOn": {
"type": "string",
"format": "date-time",
"description": "Date and time that Zuora started processing the mass action. The format is `yyyy-MM-dd hh:mm:ss`.\n"
},
"actionType": {
"type": "string",
"description": "Type of mass action.\n"
},
"errorCount": {
"type": "string",
"description": "Total number of failed records.\n\nThis field is updated in real time. When the mass action **status** is Processing, this field returns the number of records that have failed so far. When the mass action **status** is Pending, this field is null.\n"
},
"outputSize": {
"type": "integer",
"format": "int64",
"description": "Size of the response file in bytes.\n"
},
"outputType": {
"type": "string",
"description": "Type of output for the response file. The following table describes the output type.\n\n| Output Type | Description |\n|----------------|-------------------------------------|\n| (url:.csv.zip) | URL pointing to a zipped .csv file. |\n"
},
"totalCount": {
"type": "string",
"description": "Total number of records in the uploaded mass action file.\nWhen the mass action **status** is Pending, this field is null.\n"
},
"uploadedBy": {
"type": "string",
"description": "Email of the person who uploaded the mass action file.\n"
},
"uploadedOn": {
"type": "string",
"format": "date-time",
"description": "Date and time that the mass action file was uploaded. The format is `yyyy-MM-dd hh:mm:ss`.\n"
},
"successCount": {
"type": "string",
"description": "Total number of successful records.\nThis field is updated in real time. When the mass action **status** is Processing, this field returns the number of records that have succeeded so far. When the mass action **status** is Pending, this field is null.\n"
},
"processedCount": {
"type": "string",
"description": "Total number of processed records. This field is equal to the sum of `errorCount` and `successCount`.\n\nThis field is updated in real time. When the mass action **status** is Processing, this field returns the number of records that have been processed so far. When the mass action **status** is Pending, this field is null.\n"
}
}
}
GETOpenPaymentMethodTypeRevisionResponse
{
"properties": {
"label": {
"type": "string",
"description": "The label that is used to refer to this type in the Zuora UI.\n"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OpenPaymentMethodTypeResponseFields"
},
"description": "An array containing field metadata of the custom payment method type.\n"
},
"status": {
"type": "string",
"description": "The status of the custom payment method type.\n"
},
"version": {
"type": "string",
"description": "The time when the custom payment method type was first published.\n"
},
"entityId": {
"type": "string",
"description": "If an entity UUID is provided, this custom payment method type is specific to this entity only. If no entity UUID is provided, the custom payment method type is available to the global entity and all the sub entities in the tenant.\n"
},
"revision": {
"type": "integer",
"description": "The revision number of the custom payment method type, which starts from 1 and increases by 1 when you update a published revision for the first time.\n"
},
"tenantId": {
"type": "string",
"description": "Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities.\n"
},
"internalName": {
"type": "string",
"description": "A string to identify the custom payment method type in the API name of the payment method type.\n\nThis field is used along with the `tenantId` field by the system to construct and generate the API name of the custom payment method type in the following way:\n\n`<internalName>__c_<tenantId>`\n\nFor example, if `internalName` is `AmazonPay`, and `tenantId` is `12368`, the API name of the custom payment method type will be `AmazonPay__c_12368`.\n"
},
"subTypeField": {
"type": "string",
"description": "The identification reference indicating the subtype of the custom payment method.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.\n"
},
"userReferenceIdField": {
"type": "string",
"description": "The identification reference of the user or customer account.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.\n"
},
"methodReferenceIdField": {
"type": "string",
"description": "The identification reference of the custom payment method.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.\n"
}
}
}
GETPMAccountHolderInfo
{
"type": "object",
"title": "accountHolderInfo",
"properties": {
"city": {
"type": "string",
"description": "The city where the account holder stays.\n"
},
"email": {
"type": "string",
"description": "The email address of the account holder.\n"
},
"phone": {
"type": "string",
"description": "The phone number of the account holder.\n"
},
"state": {
"type": "string",
"description": "The state where the account holder stays.\n"
},
"country": {
"type": "string",
"description": "The country where the account holder stays.\n\nWhen creating a payment method through a translated UI or Payment Page, a country name in a translated language might be selected. Regardless of the country texts selected when creating the payment method, only the supported country name returns in this field. For a complete list of supported country names, see <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions\" target=\"_blank\">View countries or regions</a>. Internationalization is not supported for the API field value.\n"
},
"zipCode": {
"type": "string",
"description": "The zip code for the address of the account holder.\n"
},
"addressLine1": {
"type": "string",
"description": "The first line of the address for the account holder.\n"
},
"addressLine2": {
"type": "string",
"description": "The second line of the address for the account holder. \n"
},
"accountHolderName": {
"type": "string",
"description": "The full name of the account holder.\n"
}
},
"description": "The account holder information.\n"
}
GETPaymentGatwaysResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"paymentgateways": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETAPaymentGatwayResponse"
},
"description": ""
}
}
}
GETPaymentItemPartCollectionType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"itemParts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETPaymentItemPartTypewithSuccess"
},
"description": "Container for payment part items.\n"
}
}
}
GETPaymentItemPartType
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the payment part item.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the payment part item.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"taxItemId": {
"type": "string",
"description": "The ID of the taxation item associated with the payment part item.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the payment part item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment part item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the payment part item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment part item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the invoice item associated with the payment part item.\n"
},
"debitMemoItemId": {
"type": "string",
"description": "The ID of the debit memo item associated with the payment part item.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
}
}
}
GETPaymentItemPartTypewithSuccess
{
"type": "object",
"title": "itemParts",
"properties": {
"id": {
"type": "string",
"description": "The ID of the payment part item.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the payment part item.\n"
},
"taxItemId": {
"type": "string",
"description": "The ID of the taxation item associated with the payment part item.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the payment part item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment part item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the payment part item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment part item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the invoice item associated with the payment part item.\n"
},
"debitMemoItemId": {
"type": "string",
"description": "The ID of the debit memo item associated with the payment part item.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
}
}
}
GETPaymentMethodResponse
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The payment method ID.\n"
},
"type": {
"type": "string",
"description": "The type of the payment method. For example, `CreditCard`.\n"
},
"status": {
"enum": [
"Active",
"Closed",
"Scrubbed"
],
"type": "string",
"description": "The status of the payment method.\n"
},
"tokenId": {
"type": "string",
"description": "A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile.\n\n**Note:** This field is only returned for the Credit Card Reference Transaction payment type.\n"
},
"createdBy": {
"type": "string",
"description": "ID of the user who created this payment method."
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment method was created, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"ipAddress": {
"type": "string",
"description": "The IP address of the user when the payment method was created or updated.\n"
},
"isDefault": {
"type": "boolean",
"description": "Indicates whether this payment method is the default payment method for the account.\n"
},
"updatedBy": {
"type": "string",
"description": "ID of the user who made the last update to this payment method."
},
"updatedOn": {
"type": "string",
"format": "date-time",
"description": "The last date and time when the payment method was updated, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"mandateInfo": {
"$ref": "#/components/schemas/POSTPMMandateInfo"
},
"secondTokenId": {
"type": "string",
"description": "A gateway unique identifier that replaces sensitive payment method data.\n\n**Note:** This field is only returned for the Credit Card Reference Transaction payment type.\n"
},
"creditCardType": {
"type": "string",
"description": "The type of the credit card or debit card.\n\nPossible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).\n\n**Note:** This field is only returned for the Credit Card and Debit Card payment types.\n"
},
"deviceSessionId": {
"type": "string",
"description": "The session ID of the user when the `PaymentMethod` was created or updated.\n"
},
"existingMandate": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Indicates whether the mandate is an existing mandate.\n"
},
"lastTransaction": {
"type": "string",
"description": "ID of the last transaction of this payment method."
},
"accountHolderInfo": {
"$ref": "#/components/schemas/GETPMAccountHolderInfo"
},
"paymentRetryWindow": {
"type": "integer",
"description": "The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours.\n"
},
"lastTransactionTime": {
"type": "string",
"format": "date-time",
"description": "The time when the last transaction of this payment method happened."
},
"useDefaultRetryRule": {
"type": "boolean",
"description": "Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings.\n"
},
"creditCardMaskNumber": {
"type": "string",
"description": "The masked credit card number, such as:\n```\n*********1112\n```\n"
},
"numConsecutiveFailures": {
"type": "integer",
"format": "int32",
"description": "The number of consecutive failed payments for this payment method. It is reset to `0` upon successful payment. \n"
},
"bankIdentificationNumber": {
"type": "string",
"description": "The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method.\n"
},
"totalNumberOfErrorPayments": {
"type": "integer",
"format": "int32",
"description": "The number of error payments that used this payment method.\n"
},
"lastFailedSaleTransactionDate": {
"type": "string",
"format": "date-time",
"description": "The date of the last failed attempt to collect payment with this payment method.\n"
},
"maxConsecutivePaymentFailures": {
"type": "integer",
"description": "The number of allowable consecutive failures Zuora attempts with the payment method before stopping.\n"
},
"totalNumberOfProcessedPayments": {
"type": "integer",
"format": "int32",
"description": "The number of successful payments that used this payment method.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
},
{
"$ref": "#/components/schemas/GETPaymentMethodResponseBankTransfer"
},
{
"$ref": "#/components/schemas/GETPaymentMethodResponseACH"
},
{
"$ref": "#/components/schemas/GETPaymentMethodResponseCreditCard"
},
{
"$ref": "#/components/schemas/GETPaymentMethodResponsePayPal"
},
{
"$ref": "#/components/schemas/GETPaymentMethodResponseGooglePay"
},
{
"$ref": "#/components/schemas/GETPaymentMethodResponseApplePay"
}
]
}
GETPaymentMethodResponseACH
{
"type": "object",
"properties": {
"bankName": {
"type": "string",
"description": "The name of the bank where the ACH payment account is held. This field is only required if the `type` field is set to `ACH`.\n\nWhen creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value.\n"
},
"bankABACode": {
"type": "string",
"description": "The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`.\n"
},
"bankAccountName": {
"type": "string",
"description": "The name of the account holder, which can be either a person or a company. This field is only required if the `type` field is set to `ACH`.\n"
},
"bankAccountType": {
"enum": [
"BusinessChecking",
"Checking",
"Saving"
],
"type": "string",
"description": "The type of bank account associated with the ACH payment. This field is only required if the `type` field is set to `ACH`.\n\nWhen creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, `Checking` preferably.\n"
},
"bankAccountNumber": {
"type": "string",
"description": "The bank account number associated with the ACH payment. This field is only required if the `type` field is set to `ACH`.\n"
}
}
}
GETPaymentMethodResponseACHForAccount
{
"type": "object",
"properties": {
"bankABACode": {
"type": "string",
"description": "The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`.\n"
},
"bankAccountName": {
"type": "string",
"description": "The name of the account holder, which can be either a person or a company. This field is only required if the `type` field is set to `ACH`.\n"
}
}
}
GETPaymentMethodResponseApplePay
{
"type": "object",
"properties": {
"appleBIN": {
"type": "string",
"description": "This field is only available for Apple Pay payment methods.\n"
},
"appleCardType": {
"type": "string",
"description": "This field is only available for Apple Pay payment methods.\n\nFor Apple Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field.\n"
},
"appleCardNumber": {
"type": "string",
"description": "This field is only available for Apple Pay payment methods.\n"
},
"appleExpiryDate": {
"type": "string",
"description": "This field is only available for Apple Pay payment methods.\n"
},
"appleGatewayToken": {
"type": "string",
"description": "This field is only available for Apple Pay payment methods.\n"
}
}
}
GETPaymentMethodResponseApplePayForAccount
{
"type": "object",
"properties": {
"appleBIN": {
"type": "string",
"description": "This field is only available for Apple Pay payment methods.\n"
},
"appleCardType": {
"type": "string",
"description": "This field is only available for Apple Pay payment methods.\n\nFor Apple Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field.\n"
},
"appleCardNumber": {
"type": "string",
"description": "This field is only available for Apple Pay payment methods.\n"
},
"appleExpiryDate": {
"type": "string",
"description": "This field is only available for Apple Pay payment methods.\n"
},
"appleGatewayToken": {
"type": "string",
"description": "This field is only available for Apple Pay payment methods.\n"
}
}
}
GETPaymentMethodResponseBankTransfer
{
"type": "object",
"properties": {
"IBAN": {
"type": "string",
"description": "The International Bank Account Number used to create the SEPA payment method. The value is masked.\n"
},
"bankCode": {
"type": "string",
"description": "The sort code or number that identifies the bank. This is also known as the sort code. \n"
},
"branchCode": {
"type": "string",
"description": "The branch code of the bank used for Direct Debit. \n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer's bank account and it is masked.\n"
},
"identityNumber": {
"type": "string",
"description": "The identity number of the account holder or the cardholder.\n"
},
"bankTransferType": {
"type": "string",
"description": "The type of the Bank Transfer payment method. For example, `SEPA`.\n"
},
"businessIdentificationCode": {
"type": "string",
"description": "The BIC code used for SEPA. The value is masked. \n"
}
}
}
GETPaymentMethodResponseBankTransferForAccount
{
"type": "object",
"properties": {
"IBAN": {
"type": "string",
"description": "The International Bank Account Number used to create the SEPA payment method. The value is masked.\n"
},
"bankCode": {
"type": "string",
"description": "The sort code or number that identifies the bank. This is also known as the sort code. \n"
},
"branchCode": {
"type": "string",
"description": "The branch code of the bank used for Direct Debit.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer's bank account and it is masked.\n"
},
"identityNumber": {
"type": "string",
"description": "The identity number of the account holder or the cardholder.\n"
},
"bankTransferType": {
"type": "string",
"description": "The type of the Bank Transfer payment method. For example, `SEPA`.\n"
},
"businessIdentificationCode": {
"type": "string",
"description": "The BIC code used for SEPA. The value is masked. \n"
}
}
}
GETPaymentMethodResponseCreditCard
{
"type": "object",
"properties": {
"cardNumber": {
"type": "string",
"description": "The masked credit card number.\n\nWhen `cardNumber` is `null`, the following fields will not be returned:\n - `expirationMonth`\n - `expirationYear`\n - `accountHolderInfo`\n"
},
"securityCode": {
"type": "string",
"description": "The CVV or CVV2 security code for the credit card or debit card.\n Only required if changing expirationMonth, expirationYear, or cardHolderName.\n To ensure PCI compliance, this value isn''t stored and can''t be queried. \n"
},
"expirationYear": {
"type": "integer",
"description": "Four-digit expiration year.\n"
},
"expirationMonth": {
"type": "integer",
"description": "One or two digits expiration month (1-12).\n \n"
}
}
}
GETPaymentMethodResponseCreditCardForAccount
{
"type": "object",
"properties": {
"cardNumber": {
"type": "string",
"description": "The masked credit card number.\n\nWhen `cardNumber` is `null`, the following fields will not be returned:\n - `expirationMonth`\n - `expirationYear`\n - `accountHolderInfo`\n"
},
"securityCode": {
"type": "string",
"description": "The CVV or CVV2 security code for the credit card or debit card.\n Only required if changing expirationMonth, expirationYear, or cardHolderName.\n To ensure PCI compliance, this value isn''t stored and can''t be queried. \n"
},
"expirationYear": {
"type": "integer",
"description": "Four-digit expiration year.\n"
},
"expirationMonth": {
"type": "integer",
"description": "One or two digits expiration month (1-12).\n"
}
}
}
GETPaymentMethodResponseForAccount
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The payment method ID.\n"
},
"type": {
"type": "string",
"description": "The type of the payment method. For example, `CreditCard`.\n"
},
"status": {
"enum": [
"Active",
"Closed",
"Scrubbed"
],
"type": "string",
"description": "The status of the payment method.\n"
},
"tokenId": {
"type": "string",
"description": "A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile.\n\n**Note:** This field is only returned for the Credit Card Reference Transaction payment type.\n"
},
"createdBy": {
"type": "string",
"description": "ID of the user who created this payment method."
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment method was created, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"ipAddress": {
"type": "string",
"description": "The IP address of the user when the payment method was created or updated.\n"
},
"isDefault": {
"type": "boolean",
"description": "Indicates whether this payment method is the default payment method for the account.\n"
},
"updatedBy": {
"type": "string",
"description": "ID of the user who made the last update to this payment method."
},
"updatedOn": {
"type": "string",
"format": "date-time",
"description": "The last date and time when the payment method was updated, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"mandateInfo": {
"$ref": "#/components/schemas/POSTAccountPMMandateInfo"
},
"secondTokenId": {
"type": "string",
"description": "A gateway unique identifier that replaces sensitive payment method data.\n\n**Note:** This field is only returned for the Credit Card Reference Transaction payment type.\n"
},
"creditCardType": {
"type": "string",
"description": "The type of the credit card or debit card.\n\nPossible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).\n\n**Note:** This field is only returned for the Credit Card and Debit Card payment types.\n"
},
"deviceSessionId": {
"type": "string",
"description": "The session ID of the user when the `PaymentMethod` was created or updated.\n"
},
"existingMandate": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Indicates whether the mandate is an existing mandate.\n"
},
"lastTransaction": {
"type": "string",
"description": "ID of the last transaction of this payment method."
},
"accountHolderInfo": {
"$ref": "#/components/schemas/GETAccountPMAccountHolderInfo"
},
"paymentRetryWindow": {
"type": "integer",
"description": "The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours.\n"
},
"lastTransactionTime": {
"type": "string",
"format": "date-time",
"description": "The time when the last transaction of this payment method happened."
},
"useDefaultRetryRule": {
"type": "boolean",
"description": "Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings.\n"
},
"creditCardMaskNumber": {
"type": "string",
"description": "The masked credit card number, such as:\n```\n*********1112\n```\n**Note:** This field is only returned for Credit Card Reference Transaction payment type.\n"
},
"numConsecutiveFailures": {
"type": "integer",
"format": "int32",
"description": "The number of consecutive failed payments for this payment method. It is reset to `0` upon successful payment. \n"
},
"bankIdentificationNumber": {
"type": "string",
"description": "The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method.\n"
},
"totalNumberOfErrorPayments": {
"type": "integer",
"format": "int32",
"description": "The number of error payments that used this payment method.\n"
},
"lastFailedSaleTransactionDate": {
"type": "string",
"format": "date-time",
"description": "The date of the last failed attempt to collect payment with this payment method.\n"
},
"maxConsecutivePaymentFailures": {
"type": "integer",
"description": "The number of allowable consecutive failures Zuora attempts with the payment method before stopping.\n"
},
"totalNumberOfProcessedPayments": {
"type": "integer",
"format": "int32",
"description": "The number of successful payments that used this payment method.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFieldsForAccount"
},
{
"$ref": "#/components/schemas/GETPaymentMethodResponseBankTransferForAccount"
},
{
"$ref": "#/components/schemas/GETPaymentMethodResponseACHForAccount"
},
{
"$ref": "#/components/schemas/GETPaymentMethodResponseCreditCardForAccount"
},
{
"$ref": "#/components/schemas/GETPaymentMethodResponsePayPalForAccount"
},
{
"$ref": "#/components/schemas/GETPaymentMethodResponseGooglePayForAccount"
},
{
"$ref": "#/components/schemas/GETPaymentMethodResponseApplePayForAccount"
}
]
}
GETPaymentMethodResponseGooglePay
{
"type": "object",
"properties": {
"googleBIN": {
"type": "string",
"description": "This field is only available for Google Pay payment methods.\n"
},
"googleCardType": {
"type": "string",
"description": "This field is only available for Google Pay payment methods.\n\nFor Google Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field.\n"
},
"googleCardNumber": {
"type": "string",
"description": "This field is only available for Google Pay payment methods.\n"
},
"googleExpiryDate": {
"type": "string",
"description": "This field is only available for Google Pay payment methods.\n"
},
"googleGatewayToken": {
"type": "string",
"description": "This field is only available for Google Pay payment methods.\n"
}
}
}
GETPaymentMethodResponseGooglePayForAccount
{
"type": "object",
"properties": {
"googleBIN": {
"type": "string",
"description": "This field is only available for Google Pay payment methods.\n"
},
"googleCardType": {
"type": "string",
"description": "This field is only available for Google Pay payment methods.\n\nFor Google Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field.\n"
},
"googleCardNumber": {
"type": "string",
"description": "This field is only available for Google Pay payment methods.\n"
},
"googleExpiryDate": {
"type": "string",
"description": "This field is only available for Google Pay payment methods.\n"
},
"googleGatewayToken": {
"type": "string",
"description": "This field is only available for Google Pay payment methods.\n"
}
}
}
GETPaymentMethodResponsePayPal
{
"type": "object",
"properties": {
"BAID": {
"type": "string",
"description": "ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9.\n"
},
"email": {
"type": "string",
"description": "Email address associated with the PayPal payment method. \n"
},
"preapprovalKey": {
"type": "string",
"description": "The PayPal preapproval key.\n"
}
}
}
GETPaymentMethodResponsePayPalForAccount
{
"type": "object",
"properties": {
"BAID": {
"type": "string",
"description": "ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9.\n"
},
"email": {
"type": "string",
"description": "Email address associated with the PayPal payment method. \n"
},
"preapprovalKey": {
"type": "string",
"description": "The PayPal preapproval key. \n"
}
}
}
GETPaymentMethodUpdaterInstancesResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Indicates whether the call is successful."
},
"updaters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the PMU instance.\n"
},
"isTest": {
"type": "string",
"description": "`true` indicates that this PMU instance is for testing.\n"
},
"isActive": {
"type": "boolean",
"description": "`true` indicates that this PMU instance is active.\n"
},
"isDefault": {
"type": "boolean",
"description": "`true` indicates that it is the default PMU instance.\n"
},
"processVisa": {
"type": "boolean",
"description": "`true` indicates that Visa data processing is supported.\n"
},
"updaterName": {
"type": "string",
"description": "The name of the PMU instance.\n"
},
"processMastercard": {
"type": "boolean",
"description": "`true` indicates that Mastercard data processing is supported.\n"
},
"updaterGatewayType": {
"type": "string",
"description": "The payment gateway type of the PMU instance.\n"
},
"daysToUpdateBeforeBcd": {
"type": "integer",
"description": "The days prior to the Bill Cycle Day to start PMU service.\n"
},
"processAssociatedGwOnly": {
"type": "boolean",
"description": "`true` indicates that only the payment methods for customer accounts that meet either of the following conditions are included in the updates:\n - The default payment gateway of the customer account is set to an instance of the same type as `updaterGatewayType`.\n - The default payment gateway of the customer account is not configured, but the default payment gateway of the tenant is set to an instance of the same type as `updaterGatewayType`.\n\n`false` indicates that information of all payment methods is submitted.\n"
},
"processAutopayDefaultPmOnly": {
"type": "boolean",
"description": "`true` indicates that only the default payment methods for customer accounts with the AutoPay setting enabled are included in the updates. \n\n`false` indicates that data of all payment methods for all customer accounts is submitted, regardless of whether AutoPay is enabled for the customer account or not.\n"
}
},
"description": "Container for PMU instances available on your tenant.\n"
}
}
}
GETPaymentPartType
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the payment part.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the payment part.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"invoiceId": {
"type": "string",
"description": "The ID of the invoice associated with the payment part.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the payment part.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"debitMemoId": {
"type": "string",
"description": "The ID of the debit memo associated with the payment part.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the payment part.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment part was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
}
}
}
GETPaymentPartTypewithSuccess
{
"type": "object",
"title": "parts",
"properties": {
"id": {
"type": "string",
"description": "The ID of the payment part.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the payment part.\n"
},
"invoiceId": {
"type": "string",
"description": "The ID of the invoice associated with the payment part.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the payment part.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"debitMemoId": {
"type": "string",
"description": "The ID of the debit memo associated with the payment part.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the payment part.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment part was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
}
}
}
GETPaymentPartsCollectionType
{
"type": "object",
"properties": {
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETPaymentPartTypewithSuccess"
},
"description": "Container for payment parts.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
}
}
GETPaymentRunCollectionType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"nextPage": {
"type": "string",
"description": "The URL for requesting the next page of the response, if it exists; otherwise absent.\n"
},
"paymentRuns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETPaymentRunType"
},
"description": "Container for payment runs.\n"
}
}
}
GETPaymentRunDataArrayResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETPaymentRunDataElementResponse"
},
"description": "Container for payment run data. Each element in the array is a record processed by the payment run.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
}
}
}
GETPaymentRunDataElementResponse
{
"allOf": [
{
"type": "object",
"title": "payment run data",
"properties": {
"amount": {
"type": "number",
"description": "The amount specified in the `data` field when creating the payment run. `null` is returned if it was not specified.\n"
},
"result": {
"enum": [
"Processed",
"Error"
],
"type": "string",
"description": "Indicates whether the data is processed successfully or not.\n"
},
"comment": {
"type": "string",
"description": "The comment specified in the `data` field when creating the payment run. `null` is returned if it was not specified.\n"
},
"currency": {
"type": "string",
"description": "This field is only available if support for standalone payments is enabled.\n\nThe currency of the standalone payment. The currency of the standalone payment can be different from the payment currency defined in the customer account settings.\n"
},
"accountId": {
"type": "string",
"description": "The customer account ID specified in the `data` field when creating the payment run.\n"
},
"errorCode": {
"type": "string",
"description": "The error code of the response.\n"
},
"documentId": {
"type": "string",
"description": "The billing document ID specified in the `data` field when creating the payment run. `null` is returned if it was not specified.\n"
},
"standalone": {
"type": "boolean",
"description": "This field is only available if the support for standalone payment is enabled.\n\nThe value `true` indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred.\n"
},
"documentType": {
"enum": [
"Invoice",
"DebitMemo"
],
"type": "string",
"description": "The billing document type specified in the `data` field when creating the payment run. `null` is returned if it was not specified.\n"
},
"errorMessage": {
"type": "string",
"description": "The detailed information of the error response.\n"
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETPaymentRunDataTransactionElementResponse"
},
"description": "Container for transactions that apply to the current request. Each element contains an array of the settlement/payment applied to the record.\n"
},
"accountNumber": {
"type": "string",
"description": "The customer account number specified in the `data` field when creating the payment run.\n"
},
"documentNumber": {
"type": "string",
"description": "The billing document number specified in the `data` field when creating the payment run. `null` is returned if it was not specified.\n"
},
"amountCollected": {
"type": "number",
"description": "The amount that is collected.\n"
},
"amountToCollect": {
"type": "number",
"description": "The amount to be collected.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The payment method ID specified in the `data` field when creating the payment run. `null` is returned if it was not specified.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "The payment gateway ID specified in the `data` field when creating the payment run. `null` is returned if it was not specified.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentObjectCustomFields"
}
]
}
GETPaymentRunDataTransactionElementResponse
{
"type": "object",
"title": "payment run transaction",
"properties": {
"id": {
"type": "string",
"description": "The ID of the current transaction.\n"
},
"type": {
"enum": [
"Payment",
"CreditMemo",
"UnappliedPayment",
"CreditBalanceAdjustment"
],
"type": "string",
"description": "The type of the current transaction.\n"
},
"amount": {
"type": "number",
"description": "The total amount of the newly generated payment.\n\n**Note:** This field is only available if `type` is `Payment`.\n"
},
"status": {
"enum": [
"Processed",
"Processing",
"Error"
],
"type": "string",
"description": "The status of the newly generated payment.\n\n**Note:** This field is only available if `type` is `Payment`.\n"
},
"errorCode": {
"type": "string",
"description": "The error code of the response.\n\n**Note:** This field is only available if `type` is `Payment`.\n"
},
"errorMessage": {
"type": "string",
"description": "The detailed information of the error response.\n\n**Note:** This field is only available if `type` is `Payment`.\n"
},
"appliedAmount": {
"type": "number",
"description": "The amount allocated to this data record.\n"
}
}
}
GETPaymentRunSummaryResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"totalValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETPaymentRunSummaryTotalValues"
},
"description": "Container for total values.\n"
},
"numberOfErrors": {
"type": "integer",
"description": "The number of payments with the status of `Error` and `Processing`.\n"
},
"numberOfInvoices": {
"type": "integer",
"description": "**Note:** This field is only available if you have the Invoice Settlement feature enabled.\n\nThe total number of invoices that are picked up for processing in the payment run.\n"
},
"numberOfPayments": {
"type": "integer",
"description": "The number of payments that are successfully processed in the payment run.\n"
},
"numberOfInputData": {
"type": "integer",
"description": "The total number of input data.\n"
},
"numberOfDebitMemos": {
"type": "integer",
"description": "**Note:** This field is only available if you have the Invoice Settlement feature enabled.\n\nThe total number of debit memos that are picked up for processing in the payment run.\n"
},
"numberOfCreditMemos": {
"type": "integer",
"description": "**Note:** This field is only available if you have the Invoice Settlement feature enabled.\n\nThe total number of credit memos that are successfully processed in the payment run.\n"
},
"numberOfReceivables": {
"type": "integer",
"description": "The total number of receivables that are picked up for processing in the payment run.\n\nThe value of this field is the sum of the value of the `numberOfInvoices` field and that of the `numberOfDebitMemos` field.\n"
},
"numberOfErrorInputData": {
"type": "integer",
"description": "The number of input data that are processed with errors.\n"
},
"numberOfUnappliedPayments": {
"type": "integer",
"description": "**Note:** This field is only available if you have the Invoice Settlement feature enabled.\n\nThe number of unapplied payments that are successfully processed in the payment run.\n"
},
"numberOfProcessedInputData": {
"type": "integer",
"description": "The number of input data that are successfully processed.\n"
},
"numberOfUnprocessedInvoices": {
"type": "integer",
"description": "**Note:** This field is only available if you have the Invoice Settlement feature enabled.\n\nThe number of invoices with remaining positive balances after the payment run is completed.\n"
},
"numberOfUnprocessedDebitMemos": {
"type": "integer",
"description": "**Note:** This field is only available if you have the Invoice Settlement feature enabled.\n\nThe number of debit memos with remaining positive balances after the payment run is completed.\n"
},
"numberOfUnprocessedReceivables": {
"type": "integer",
"description": "The number of receivables with remaining positive balances after the payment run is completed.\n"
},
"numberOfCreditBalanceAdjustments": {
"type": "integer",
"description": "**Note:** This field is only available if you have the Credit Balance feature enabled.\n\nThe number of credit balance adjustments that are successfully processed in the payment run.\n"
}
}
}
GETPaymentRunSummaryTotalValues
{
"type": "object",
"title": "totalValues",
"properties": {
"totalValueOfErrors": {
"type": "string",
"description": "The total amount of receivables associated with the payments with the status of `Error` and `Processing`.\n"
},
"totalValueOfInvoices": {
"type": "string",
"description": "**Note:** This field is only available if you have the Invoice Settlement feature enabled.\n\nThe total amount of invoices that are picked up for processing in the payment run.\n"
},
"totalValueOfPayments": {
"type": "string",
"description": "The total amount of payments that are successfully processed in the payment run.\n"
},
"totalValueOfDebitMemos": {
"type": "string",
"description": "**Note:** This field is only available if you have the Invoice Settlement feature enabled.\n\nThe total amount of debit memos that are picked up for processing in the payment run.\n"
},
"totalValueOfCreditMemos": {
"type": "string",
"description": "**Note:** This field is only available if you have the Invoice Settlement feature enabled.\n\nThe total amount of credit memos that are successfully processed in the payment run.\n"
},
"totalValueOfReceivables": {
"type": "string",
"description": "The total amount of receivables associated with the payment run.\n\nThe value of this field is the sum of the value of the `totalValueOfInvoices` field and that of the `totalValueOfDebitMemos` field.\n"
},
"totalValueOfCreditBalance": {
"type": "string",
"description": "**Note:** This field is only available if you have the Credit Balance feature enabled.\n\nThe total amount of credit balance after the payment run is completed.\n"
},
"totalValueOfUnappliedPayments": {
"type": "integer",
"description": "**Note:** This field is only available if you have the Invoice Settlement feature enabled.\n\nThe total amount of unapplied payments that are successfully processed in the payment run.\n"
},
"totalValueOfUnprocessedInvoices": {
"type": "string",
"description": "**Note:** This field is only available if you have the Invoice Settlement feature enabled.\n\nThe total amount of invoices with remaining positive balances after the payment run is completed.\n"
},
"totalValueOfUnprocessedDebitMemos": {
"type": "string",
"description": "**Note:** This field is only available if you have the Invoice Settlement feature enabled.\n\nThe total amount of debit memos with remaining positive balances after the payment run is completed.\n"
},
"totalValueOfUnprocessedReceivables": {
"type": "string",
"description": "The total amount of receivables with remaining positive balances after the payment run is completed.\n"
}
}
}
GETPaymentRunType
{
"type": "object",
"title": "paymentRuns",
"properties": {
"id": {
"type": "string",
"description": "The ID of the payment run.\n"
},
"batch": {
"type": "string",
"example": "Batch1",
"description": "The alias name given to a batch.\n"
},
"number": {
"type": "string",
"description": "The identification number of the payment run.\n"
},
"status": {
"enum": [
"Pending",
"Processing",
"Completed",
"Error",
"Canceled"
],
"type": "string",
"description": "The status of the created payment run.\n"
},
"runDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the scheduled payment run is to be executed for collecting payments.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"currency": {
"type": "string",
"example": "USD",
"description": "A currency defined in the web-based UI administrative settings.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the payment run.\n"
},
"executedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment run is executed, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 11:30:37.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date used to determine which receivables to be collected in the payment run. \n"
},
"completedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment run is completed, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 11:39:58.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the payment run.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment run was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the payment run.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment run was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"billCycleDay": {
"type": "string",
"example": 1,
"description": "The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. \n"
},
"billingRunId": {
"type": "string",
"format": "uuid",
"description": "The ID of the bill run.\n"
},
"collectPayment": {
"type": "boolean",
"description": "Whether to process electronic payments during the execution of payment runs. \n"
},
"paymentGatewayId": {
"type": "string",
"format": "uuid",
"description": "The ID of the gateway instance that processes the payment.\n"
},
"applyCreditBalance": {
"type": "boolean",
"description": "**Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.\n\nWhether to apply credit balances in the payment run. This field is only available when you have Invoice Settlement feature disabled.\n"
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"autoApplyCreditMemo": {
"type": "boolean",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nWhether to automatically apply a posted credit memo to one or more receivables in the payment run.\n"
},
"consolidatedPayment": {
"type": "boolean",
"description": "**Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information. \n\nWhether to process a single payment for all receivables that are due on an account.\n"
},
"autoApplyUnappliedPayment": {
"type": "boolean",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nWhether to automatically apply unapplied payments to one or more receivables in the payment run.\n"
},
"processPaymentWithClosedPM": {
"type": "boolean",
"description": "**Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information. \n\nWhether to process payments even if the default payment method is closed.\n"
}
}
}
GETPaymentScheduleItemResponse
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the payment schedule item. For example, `412880e749b72b310149b7343ef81346`.\n"
},
"amount": {
"type": "number",
"format": "decimal",
"description": "The total amount of the payment schedule item.\n"
},
"number": {
"type": "string",
"description": "Number of the payment schedule item.\n"
},
"status": {
"enum": [
"Pending",
"Processed",
"Error",
"Canceled"
],
"type": "string",
"description": "ID of the payment method of the payment schedule item.\n\n- `Pending`: Waiting for processing.\n- `Processed`: The payment has been collected.\n- `Error`: Failed to collect the payment.\n- `Canceled`: After a pending payment schedule item is canceled by the user, the item is marked as `Canceled`.\n"
},
"balance": {
"type": "number",
"format": "decimal",
"description": "The remaining balance of payment schedule item.\n"
},
"runHour": {
"type": "integer",
"description": "At which hour in the day in the tenant’s timezone this payment will be collected. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully. \n"
},
"currency": {
"type": "string",
"description": "The currency of the payment.\n"
},
"accountId": {
"type": "string",
"description": "ID of the customer account that owns the payment schedule item, for example `402880e741112b310149b7343ef81234`.\n"
},
"paymentId": {
"type": "string",
"description": "ID of the payment that is created by the payment schedule item， or linked to the payment schedule item. This field is only available if the request doesn’t specify `zuora-version`, or `zuora-version` is set to a value equal to or smaller than `336.0`. \n"
},
"standalone": {
"type": "boolean",
"description": "Indicates if the payment created by the payment schedule item is a standalone payment.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the user who created the payment schedule item.\n"
},
"createdDate": {
"type": "string",
"format": "date",
"description": "The date and time when the payment schedule item was created.\n"
},
"description": {
"type": "string",
"description": "The description of the payment schedule item.\n"
},
"psiPayments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LinkedPaymentID"
},
"description": "Container for payments linked to the payment schedule item. \n"
},
"updatedById": {
"type": "string",
"description": "The ID of the user who updated the payment schedule item.\n"
},
"updatedDate": {
"type": "string",
"format": "date",
"description": "The date and time when the payment schedule item was last updated.\n"
},
"errorMessage": {
"type": "string",
"description": "The error message indicating if the error is related to the configuration or the payment collection.\n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
},
"scheduledDate": {
"type": "string",
"format": "date",
"description": "The scheduled date when the payment is processed.\n"
},
"billingDocument": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.\n"
},
"type": {
"type": "string",
"description": "Indicates whether the associated billing document is a debit memo or a invoice.\n"
},
"number": {
"type": "string",
"description": "The number of the billing docuemnt, for example, `INV00002345`.\n"
}
}
},
"paymentMethodId": {
"type": "string",
"description": "ID of the payment method of the payment schedule item.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "ID of the payment gateway of the payment schedule item.\n"
},
"paymentScheduleId": {
"type": "string",
"description": "ID of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`,\n"
},
"cancellationReason": {
"type": "string",
"description": "The reason for the cancellation of payment schedule item. \n"
},
"paymentScheduleNumber": {
"type": "string",
"description": "Number of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`,\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentScheduleItemCustomFields"
}
]
}
GETPaymentScheduleResponse
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the payment schedule.\n"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentScheduleItemCommonResponse"
},
"description": "Container for payment schedule items.\n"
},
"period": {
"type": "string",
"description": "For recurring payment schedule only. The period of payment generation. Available values include: `Monthly`, `Weekly`, `BiWeekly`.\n\nReturn `null` for custom payment schedules.\n"
},
"status": {
"enum": [
"Active",
"Canceled",
"Completed"
],
"type": "string",
"description": "The status of the payment schedule.\n\n- Active: There is still payment schedule item to process.\n- Canceled: After a payment schedule is canceled by the user, the schedule is marked as `Canceled`.\n- Completed: After all payment schedule items are processed, the schedule is marked as `Completed`.\n"
},
"runHour": {
"type": "integer",
"description": "[0,1,2,~,22,23]\n\nAt which hour in the day in the tenant’s timezone this payment will be collected.\n\nReturn `0` for custom payment schedules.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully. \n"
},
"isCustom": {
"type": "boolean",
"description": "Indicates if the payment schedule is a custom payment schedule.\n"
},
"accountId": {
"type": "string",
"description": "ID of the account that owns the payment schedule.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The date when the first payment of this payment schedule is proccessed.\n"
},
"cancelDate": {
"type": "string",
"format": "date",
"description": "Specifies the effective date by when the payment schedule will be canceled.\n"
},
"prepayment": {
"type": "boolean",
"description": "Indicates whether the payments created by the payment schedule are used as a reserved payment. This field is available only if the prepaid cash drawdown permission is enabled. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.\n"
},
"standalone": {
"type": "boolean",
"description": "Indicates if the payments that the payment schedule created are standalone payments.\n"
},
"cancelledOn": {
"type": "string",
"description": "The date when the payment schedule was canceled.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the user who created this payment schedule.\n"
},
"createdDate": {
"type": "string",
"format": "date",
"description": "The date and time the payment schedule is created.\n"
},
"description": {
"type": "string",
"description": "The description of the payment schedule.\n"
},
"occurrences": {
"type": "integer",
"description": "The number of payment schedule items that are created by this payment schedule.\n"
},
"totalAmount": {
"type": "number",
"description": "The total amount that will be collected by the payment schedule.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the user who last updated this payment schedule.\n"
},
"updatedDate": {
"type": "string",
"format": "date",
"description": "The date and time the payment schedule is last updated.\n"
},
"accountNumber": {
"type": "string",
"description": "Number of the account that owns the payment schedule.\n"
},
"cancelledById": {
"type": "string",
"description": "The ID of the user who canceled this payment schedule.\n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
},
"billingDocument": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.\n"
},
"type": {
"type": "string",
"description": "Indicates whether the associated billing document is a debit memo or a invoice.\n"
},
"number": {
"type": "string",
"description": "The number of the billing docuemnt, for example, `INV00002345`.\n"
}
}
},
"nextPaymentDate": {
"type": "string",
"format": "date",
"description": "The date the next payment will be processed.\n"
},
"recentPaymentDate": {
"type": "string",
"format": "date",
"description": "The date the last payment was processed.\n"
},
"totalPaymentsErrored": {
"type": "integer",
"description": "The number of errored payments.\n"
},
"paymentScheduleNumber": {
"type": "string",
"description": "Number of the payment schedule.\n"
},
"totalPaymentsProcessed": {
"type": "integer",
"description": "The number of processed payments.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentScheduleCustomFields"
}
]
}
GETPaymentScheduleStatisticResponse
{
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date",
"description": "The specified date.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"paymentRuns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentRunStatistic"
},
"title": "PaymentRunStatistic"
},
"paymentScheduleItems": {
"type": "object",
"properties": {
"error": {
"type": "integer",
"description": "The number of errored payment schedule items. \n"
},
"pending": {
"type": "integer",
"description": "The number of pending payment schedule items.\n"
},
"processed": {
"type": "integer",
"description": "The number of processed payment schedule items. \n"
}
}
}
},
"description": "The object that contains the payment schedule statistic of the specified date.\n"
}
GETPaymentSchedulesResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentScheduleCommonResponse"
},
"description": "Container for payment schedules.\n"
}
GETProductChargeDefinitionPricing
{
"type": "object",
"title": "prices",
"properties": {
"price": {
"type": "number",
"description": "The price of this item. \n\nThis field is only applicable for charges based on the following charge models:\n - Flat Fee\n - Per Unit\n - Delivery Pricing\n"
},
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETChargeDefinitionPricingTier"
},
"description": "Container for the tiers of the price item. \n\nThis field is only applicable for charges based on the following charge models:\n - Tiered Pricing\n - Volume Pricing\n - Tiered with Overage Pricing\n"
},
"currency": {
"type": "string",
"description": "The currency for the price.\n"
},
"overagePrice": {
"type": "number",
"description": "The overage price of the price item. \n\nThis field is only applicable for charges based on the Overage Pricing or Tiered with Overage Pricing charge model.\n"
},
"includedUnits": {
"type": "number",
"description": "The number of units included in this price item. \n\nThis field is only applicable for charges based on the Overage Pricing charge model.\n"
},
"discountAmount": {
"type": "number",
"format": "double",
"description": "The specific amount for a fixed discount. The field is applicable only for charges based on the Discount-Fixed Amount charge model.\n"
},
"discountPercentage": {
"type": "number",
"format": "double",
"description": "The percentage of discount for a percentage discount. The field is applicable only for charges based on the Discount-Percentage charge model.\n"
}
}
}
GETProductChargeDefinitionResponse
{
"type": "object",
"properties": {
"uom": {
"type": "string",
"nullable": true,
"description": "Indicates the unit of measure (UOM) that is configured in **Settings > Billing** for the product rate plan charge.\n"
},
"term": {
"type": "number",
"nullable": true,
"description": "The number of periods of a termed subscription that is eligible for this charge definition. This field is applicable when the `termType` field is set to `TERMED`, \nand is to be used together with the `termPeriodType` field.\n"
},
"prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETProductChargeDefinitionPricing"
},
"description": "Container for the prices of the product charge definition.\n"
},
"success": {
"type": "boolean",
"description": "Indicates whether the request succeeded.\n"
},
"taxCode": {
"type": "string",
"maxLength": 64,
"description": "Specifies the tax code for taxation rules.\n\n**Note**: This value affects the tax calculation of the rate plan charge.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive",
null
],
"type": "string",
"nullable": true,
"description": "Determines how to define taxation for the charge.\n\n**Note**: This value affects the tax calculation of the rate plan charge.\n"
},
"taxable": {
"type": "boolean",
"description": "Determines whether the charge definition is taxable.\n\n**Character limit**: 5\n\n**Values**: `True`, `False`\n\n**Note**: This value affects the tax calculation of the rate plan charge.\n"
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN",
null
],
"type": "string",
"nullable": true,
"description": "The type of the subscription that is eligible for this charge definition.\n"
},
"isDefault": {
"type": "boolean",
"description": "Indicates whether this charge definition is the default one for the charge.\n"
},
"billingDay": {
"type": "string",
"description": "The bill cycle type for the charge.\n"
},
"chargeType": {
"enum": [
"OneTime",
"Recurring",
"Usage"
],
"type": "string",
"description": "Indicates the type of charge.\n"
},
"isUnbilled": {
"type": "boolean",
"description": "Specifies how to perform the accounting during revenue recognition. The default value is `false`.\n\n**Values**: `true`, `false`\n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled. \n"
},
"revRecCode": {
"type": "string",
"nullable": true,
"maxLength": 70,
"description": "Associates this product rate plan charge with a specific revenue recognition code.\n"
},
"chargeModel": {
"enum": [
"DiscountFixedAmount",
"DiscountPercentage",
"FlatFee",
"PerUnit",
"Overage",
"Tiered",
"TieredWithOverage",
"Volume",
"Delivery",
"MultiAttributePricing",
"PreratedPerUnit",
"PreratedPricing",
"HighWatermarkVolumePricing",
"HighWatermarkTieredPricing"
],
"type": "string",
"description": "Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n"
},
"description": {
"type": "string",
"description": "The description for the charge.\n"
},
"productLine": {
"type": "string",
"description": "This field is used to maintain the product line for integration with Zuora Revenue. \n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled.\n"
},
"ratingGroup": {
"enum": [
"ByBillingPeriod",
"ByUsageStartDate",
"ByUsageRecord",
"ByUsageUpload",
"ByGroupId",
null
],
"type": "string",
"default": "ByBillingPeriod",
"nullable": true,
"description": "The rating group based on which usage records are rated.\n\nPossible values: \n - `ByBillingPeriod`: The rating is based on all the usages in a billing period. \n - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. \n - `ByUsageRecord`: The rating is based on each usage record.\n - `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`).\n - `ByGroupId`: The rating is based on all the usages in a custom group.\n\n**Notes:** \n - The `ByBillingPeriod` value can be applied for all charge models. \n - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for Per Unit, Volume Pricing, and Tiered Pricing charge models. \n - The `ByGroupId` value is only available if you have the Active Rating feature enabled.\n - Use this field only for Usage charges. One-time charges and recurring charges return `NULL`.\n"
},
"upToPeriods": {
"type": "number",
"nullable": true,
"description": "The number of up-to periods for this charge.\n"
},
"customFields": {
"$ref": "#/components/schemas/ProductChargeDefinitionObjectCustomFields"
},
"productClass": {
"type": "string",
"description": "This field is used to maintain the product class for integration with Zuora Revenue. \n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled. \n"
},
"triggerEvent": {
"enum": [
"ContractEffective",
"ServiceActivation",
"CustomerAcceptance"
],
"type": "string",
"description": "Specifies when to start billing the customer for the charge definition.\n\n**Values**:\n - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.\n - `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access.\n - `CustomerAcceptance` is when the customer accepts the services or products for a subscription.\n"
},
"billingPeriod": {
"type": "string",
"description": "The billing period for the product charge definition.\n"
},
"billingTiming": {
"enum": [
"IN_ADVANCE",
"IN_ARREARS"
],
"type": "string",
"description": "The billing timing setting for the product charge definition.\n"
},
"discountClass": {
"type": "string",
"nullable": true,
"description": "The class that the discount belongs to. The discount class defines the order in which discount product rate plan charges are applied.\n\nFor more information, see [Manage Discount Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).\n"
},
"discountLevel": {
"enum": [
"rateplan",
"subscription",
"account",
null
],
"type": "string",
"nullable": true,
"description": "The application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year"
],
"type": "string",
"description": "The list price base. \n\nThis field is applicable only for recurring charges.\n\n**Note**: The `Per_Year` enum value is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n"
},
"productFamily": {
"type": "string",
"description": "This field is used to maintain the product family for integration with Zuora Revenue. \n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled.\n"
},
"numberOfPeriod": {
"type": "integer",
"format": "int64",
"description": "Indicates the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number.\n"
},
"smoothingModel": {
"enum": [
"RollingWindow",
"Rollover",
null
],
"type": "string",
"nullable": true,
"description": "Indicates the smoothing model for an overage smoothing charge model.\n"
},
"termPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week",
null
],
"type": "string",
"nullable": true,
"description": "The period type for the subscription term that is eligible for this charge definition.\n"
},
"applyDiscountTo": {
"enum": [
"ONETIME",
"RECURRING",
"USAGE",
"ONETIMERECURRING",
"ONETIMEUSAGE",
"RECURRINGUSAGE",
"ONETIMERECURRINGUSAGE",
null
],
"type": "string",
"nullable": true,
"description": "Indicates which type of charge the discount charge applies to.\n"
},
"defaultQuantity": {
"type": "number",
"nullable": true,
"description": "The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n"
},
"numberOfPeriods": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Specifies the number of periods to use when calculating charges in an overage smoothing charge model.\nThis field is ued when overage smoothing model is `RollingWindow` or `Rollover`.\n"
},
"productCategory": {
"type": "string",
"description": "This field is used to maintain the product category for integration with Zuora Revenue. \n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled. \n"
},
"upToPeriodsType": {
"enum": [
"Billing_Periods",
"Days",
"Weeks",
"Months",
"Years",
null
],
"type": "string",
"nullable": true,
"description": "The up-to-periods type for this charge.\n"
},
"deliverySchedule": {
"$ref": "#/components/schemas/GETDeliverySchedule"
},
"effectiveEndDate": {
"type": "string",
"format": "date-time",
"description": "The effective end date of the product charge definition.\n"
},
"endDateCondition": {
"enum": [
"Subscription_End",
"One_Time",
"Fixed_Period",
"Specific_End_Date"
],
"type": "string",
"description": "The end date condition for this charge.\n"
},
"isStackedDiscount": {
"type": "boolean",
"description": "**Note**: This field is only applicable to the Discount - Percentage charge model.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 130 or higher. Otherwise, an error occurs.\n\nThis field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:\n - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.\n - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.\n\nFor more information, see [Stacked discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).\n"
},
"priceChangeOption": {
"enum": [
"NoChange",
"SpecificPercentageValue",
"UseLatestProductCatalogPricing",
null
],
"type": "string",
"default": "NoChange",
"nullable": true,
"description": "Applies an automatic price change when a termed subscription is renewed.\n"
},
"productRatePlanId": {
"type": "string",
"nullable": true,
"description": "The unique ID of the product rate plan that uses this charge definition.\n"
},
"effectiveStartDate": {
"type": "string",
"format": "date-time",
"description": "The effective start date of the product charge definition.\n"
},
"financeInformation": {
"type": "object",
"title": "financeInformation",
"properties": {
"contractAssetAccountingCode": {
"type": "string",
"description": "The accounting code for contract asset. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for deferred revenue, such as Monthly Recurring Liability.\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment revenue. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"contractAssetAccountingCodeType": {
"type": "string",
"description": "The type associated with the contract asset accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for contract liability. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n"
},
"accountsReceivableAccountingCode": {
"type": "string",
"nullable": true,
"description": "The accounting code for accounts receivable.\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment liability. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"deferredRevenueAccountingCodeType": {
"type": "string",
"nullable": true,
"description": "The type associated with the deferred revenue accounting code, such as Deferred Revenue. \n"
},
"unbilledReceivablesAccountingCode": {
"type": "string",
"description": "The accounting code for unbilled receivables. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"adjustmentRevenueAccountingCodeType": {
"type": "string",
"description": "The type associated with the adjustment revenue accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"contractLiabilityAccountingCodeType": {
"type": "string",
"description": "The type associated with the contract liability accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"recognizedRevenueAccountingCodeType": {
"type": "string",
"nullable": true,
"description": "The type associated with the recognized revenue accounting code, such as Sales Revenue or Sales Discount.\n"
},
"accountsReceivableAccountingCodeType": {
"type": "string",
"nullable": true,
"description": "The type of the accounting code for accounts receivable.\n"
},
"adjustmentLiabilityAccountingCodeType": {
"type": "string",
"description": "The type associated with the adjustment liability accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"unbilledReceivablesAccountingCodeType": {
"type": "string",
"description": "The type associated with the unbilled receivables accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for contract recognized revenue. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"contractRecognizedRevenueAccountingCodeType": {
"type": "string",
"description": "The type associated with the contract recognized revenue accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
}
},
"description": "Container for finance information of the rate plan charge.\n"
},
"priceIncreaseOption": {
"enum": [
"FromTenantPercentageValue",
"SpecificPercentageValue"
],
"type": "string",
"description": "Applies an automatic price change when a termed subscription is renewed.\n"
},
"productRatePlanName": {
"type": "string",
"nullable": true,
"description": "Th name of the product rate plan that uses this charge definition.\n"
},
"isAllocationEligible": {
"type": "boolean",
"description": "Indicates whether the charge segment is allocation eligible in revenue recognition. The default value is `false`.\n\n**Values**: `true`, `false`\n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled.\n"
},
"productRatePlanNumber": {
"type": "string",
"nullable": true,
"description": "The unique number (natural key) of the product rate plan that uses this charge definition.\n"
},
"specificBillingPeriod": {
"type": "number",
"nullable": true,
"description": "The specific number of billing period for the product charge definition.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"nullable": true,
"description": "The number of months for the list price base of the charge definition. \nThis field is `null` if the `listPriceBase` field is not set to `Per_Specific_Months`.\n"
},
"billingPeriodAlignment": {
"enum": [
"AlignToCharge",
"AlignToSubscriptionStart",
"AlignToTermStart",
"AlignToTermEnd"
],
"type": "string",
"description": "The billing period alignment setting for the charge.\n"
},
"revRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate",
null
],
"type": "string",
"nullable": true,
"description": "Indicates when revenue recognition begins.\n"
},
"priceIncreasePercentage": {
"type": "number",
"format": "double",
"nullable": true,
"description": "Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the `priceIncreaseOption` value to `SpecificPercentageValue`.\n\n**Character limit**: 16\n\n**Values**: a decimal value between -100 and 100\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The unique ID of the product charge of the charge definition.\n"
},
"usageRecordRatingOption": {
"enum": [
"EndOfBillingPeriod",
"OnDemand",
null
],
"type": "string",
"default": "EndOfBillingPeriod",
"nullable": true,
"description": "Determines how Zuora processes usage records for per-unit usage charges.\n"
},
"overageCalculationOption": {
"enum": [
"EndOfSmoothingPeriod",
"PerBillingPeriod",
null
],
"type": "string",
"nullable": true,
"description": "Determines when to calculate overage charges. If the value of the `SmoothingMode` field is not specified, the value of this field is ignored.\n\n**Values**: \n - `EndOfSmoothingPeriod`: This option is used by default. The overage is charged at the end of the smoothing period.\n - `PerBillingPeriod`: The overage is charged on-demand rather than waiting until the end of the smoothing period.\n"
},
"recognizedRevenueAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the recognized revenue account for this charge.\n - Required when the Allow Blank Accounting Code setting is No.\n - Optional when the Allow Blank Accounting Code setting is Yes.\n\n 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"
},
"revenueRecognitionTiming": {
"enum": [
"Upon Billing Document Posting Date",
"Upon Order Activation Date"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue recognition timing.\n\nPredefined options are listed as enum values in this API Reference. \nOther options might also be avaliable depending on \nthe <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"productChargeDefinitionId": {
"type": "string",
"description": "The unique ID of the product charge definition.\n"
},
"revenueAmortizationMethod": {
"enum": [
"Immediate",
"Ratable Using Start And End Dates"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue amortization method.\n\nPredefined options are listed as enum values in this API Reference. \nOther options might also be avaliable depending on \nthe <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"revenueRecognitionRuleName": {
"enum": [
"Recognize upon invoicing",
"Recognize daily over time"
],
"type": "string",
"description": "Determines when to recognize the revenue for this charge.\n"
},
"productDiscountApplyDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETProductDiscountApplyDetailsType"
},
"description": "Container for the application details about a discount product rate plan charge. \n\nOnly discount product rate plan charges have values for this field.\n"
},
"productRatePlanChargeNumber": {
"type": "string",
"nullable": true,
"description": "The unique number (natural key) of the product charge of the charge definition.\n"
},
"productChargeDefinitionNumber": {
"type": "string",
"description": "The unique number (natural key) of the product charge definition.\n"
},
"overageUnusedUnitsCreditOption": {
"enum": [
"NoCredit",
"CreditBySpecificRate",
null
],
"type": "string",
"nullable": true,
"description": "Determines whether to credit the customer with unused units of usage.\n"
},
"useTenantDefaultForPriceChange": {
"type": "boolean",
"description": "Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal. \n\n**Character limit**: 5\n\n**Values**: `true`, `false`\n"
},
"useDiscountSpecificAccountingCode": {
"type": "boolean",
"nullable": true,
"description": "Determines whether to define a new accounting code for the new discount charge.\n\n**Character limit**: 5\n\n**Values**: `true`, `false`\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related rate plan charges and order line items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.\n"
}
}
}
GETProductChargeDefinitionsResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Indicates whether the request succeeded.\n"
},
"chargeDefinitions": {
"type": "array",
"items": {
"type": "object",
"title": "chargeDefinitions",
"properties": {
"uom": {
"type": "string",
"nullable": true,
"description": "Indicates the unit of measure (UOM) that is configured in **Settings > Billing** for the product rate plan charge.\n"
},
"term": {
"type": "number",
"nullable": true,
"description": "The number of periods of a termed subscription that is eligible for this charge definition. This field is applicable when the `termType` field is set to `TERMED`, \nand is to be used together with the `termPeriodType` field.\n"
},
"prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETProductChargeDefinitionPricing"
},
"description": "Container for the prices of the product charge definition.\n"
},
"taxCode": {
"type": "string",
"maxLength": 64,
"description": "Specifies the tax code for taxation rules.\n\n**Note**: This value affects the tax calculation of the rate plan charge.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive",
null
],
"type": "string",
"nullable": true,
"description": "Determines how to define taxation for the charge.\n\n**Note**: This value affects the tax calculation of the rate plan charge.\n"
},
"taxable": {
"type": "boolean",
"description": "Determines whether the charge definition is taxable.\n\n**Character limit**: 5\n\n**Values**: `true`, `false`\n\n**Note**: This value affects the tax calculation of the rate plan charge.\n"
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN",
null
],
"type": "string",
"nullable": true,
"description": "The type of the subscription that is eligible for this charge definition.\n"
},
"isDefault": {
"type": "boolean",
"description": "Indicates whether this charge definition is the default one for the charge.\n"
},
"billingDay": {
"type": "string",
"description": "The bill cycle type for the charge.\n"
},
"chargeType": {
"enum": [
"OneTime",
"Recurring",
"Usage"
],
"type": "string",
"description": "Indicates the type of charge.\n"
},
"isUnbilled": {
"type": "boolean",
"description": "Specifies how to perform the accounting during revenue recognition. The default value is `false`.\n\n**Values**: `true`, `false`\n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled. \n"
},
"revRecCode": {
"type": "string",
"nullable": true,
"maxLength": 70,
"description": "Associates this product rate plan charge with a specific revenue recognition code.\n"
},
"chargeModel": {
"enum": [
"DiscountFixedAmount",
"DiscountPercentage",
"FlatFee",
"PerUnit",
"Overage",
"Tiered",
"TieredWithOverage",
"Volume",
"Delivery",
"MultiAttributePricing",
"PreratedPerUnit",
"PreratedPricing",
"HighWatermarkVolumePricing",
"HighWatermarkTieredPricing"
],
"type": "string",
"description": "Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n"
},
"description": {
"type": "string",
"description": "The description for the charge.\n"
},
"productLine": {
"type": "string",
"description": "This field is used to maintain the product line for integration with Zuora Revenue. \n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled.\n"
},
"ratingGroup": {
"enum": [
"ByBillingPeriod",
"ByUsageStartDate",
"ByUsageRecord",
"ByUsageUpload",
"ByGroupId",
null
],
"type": "string",
"default": "ByBillingPeriod",
"nullable": true,
"description": "The rating group based on which usage records are rated.\n\nPossible values: \n - `ByBillingPeriod`: The rating is based on all the usages in a billing period. \n - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. \n - `ByUsageRecord`: The rating is based on each usage record.\n - `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`).\n - `ByGroupId`: The rating is based on all the usages in a custom group.\n\n**Notes:** \n - The `ByBillingPeriod` value can be applied for all charge models. \n - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for Per Unit, Volume Pricing, and Tiered Pricing charge models. \n - The `ByGroupId` value is only available if you have the Active Rating feature enabled.\n - Use this field only for Usage charges. One-time charges and recurring charges return `NULL`.\n"
},
"upToPeriods": {
"type": "number",
"nullable": true,
"description": "The number of up-to periods for this charge.\n"
},
"customFields": {
"$ref": "#/components/schemas/ProductChargeDefinitionObjectCustomFields"
},
"productClass": {
"type": "string",
"description": "This field is used to maintain the product class for integration with Zuora Revenue. \n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled. \n"
},
"triggerEvent": {
"enum": [
"ContractEffective",
"ServiceActivation",
"CustomerAcceptance"
],
"type": "string",
"description": "Specifies when to start billing the customer for the charge definition.\n\n**Values**:\n - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.\n - `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access.\n - `CustomerAcceptance` is when the customer accepts the services or products for a subscription.\n"
},
"billingPeriod": {
"type": "string",
"description": "The billing period for the product charge definition.\n"
},
"billingTiming": {
"enum": [
"IN_ADVANCE",
"IN_ARREARS"
],
"type": "string",
"description": "The billing timing setting for the product charge definition.\n"
},
"discountClass": {
"type": "string",
"nullable": true,
"description": "The class that the discount belongs to. The discount class defines the order in which discount product rate plan charges are applied.\n\nFor more information, see [Manage Discount Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).\n"
},
"discountLevel": {
"enum": [
"rateplan",
"subscription",
"account",
null
],
"type": "string",
"nullable": true,
"description": "The application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year"
],
"type": "string",
"description": "The list price base. \n\nThis field is applicable only for recurring charges.\n\n**Note**: The `Per_Year` enum value is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n"
},
"productFamily": {
"type": "string",
"description": "This field is used to maintain the product family for integration with Zuora Revenue. \n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled.\n"
},
"numberOfPeriod": {
"type": "integer",
"format": "int64",
"description": "Indicates the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number.\n"
},
"smoothingModel": {
"enum": [
"RollingWindow",
"Rollover",
null
],
"type": "string",
"nullable": true,
"description": "Indicates the smoothing model for an overage smoothing charge model.\n"
},
"termPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week",
null
],
"type": "string",
"nullable": true,
"description": "The period type for the subscription term that is eligible for this charge definition.\n"
},
"applyDiscountTo": {
"enum": [
"ONETIME",
"RECURRING",
"USAGE",
"ONETIMERECURRING",
"ONETIMEUSAGE",
"RECURRINGUSAGE",
"ONETIMERECURRINGUSAGE",
null
],
"type": "string",
"nullable": true,
"description": "Indicates which type of charge the discount charge applies to.\n"
},
"defaultQuantity": {
"type": "number",
"nullable": true,
"description": "The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n"
},
"numberOfPeriods": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Specifies the number of periods to use when calculating charges in an overage smoothing charge model.\nThis field is ued when overage smoothing model is `RollingWindow` or `Rollover`.\n"
},
"productCategory": {
"type": "string",
"description": "This field is used to maintain the product category for integration with Zuora Revenue. \n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled. \n"
},
"upToPeriodsType": {
"enum": [
"Billing_Periods",
"Days",
"Weeks",
"Months",
"Years",
null
],
"type": "string",
"nullable": true,
"description": "The up-to-periods type for this charge.\n"
},
"deliverySchedule": {
"$ref": "#/components/schemas/GETDeliverySchedule"
},
"effectiveEndDate": {
"type": "string",
"format": "date-time",
"description": "The effective end date of the product charge definition.\n"
},
"endDateCondition": {
"enum": [
"Subscription_End",
"One_Time",
"Fixed_Period",
"Specific_End_Date"
],
"type": "string",
"description": "The end date condition for this charge.\n"
},
"isStackedDiscount": {
"type": "boolean",
"description": "**Note**: This field is only applicable to the Discount - Percentage charge model.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 130 or higher. Otherwise, an error occurs.\n\nThis field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:\n - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.\n - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.\n\nFor more information, see [Stacked discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).\n"
},
"priceChangeOption": {
"enum": [
"NoChange",
"SpecificPercentageValue",
"UseLatestProductCatalogPricing",
null
],
"type": "string",
"default": "NoChange",
"nullable": true,
"description": "Applies an automatic price change when a termed subscription is renewed.\n"
},
"productRatePlanId": {
"type": "string",
"nullable": true,
"description": "The unique ID of the product rate plan that uses this charge definition.\n"
},
"effectiveStartDate": {
"type": "string",
"format": "date-time",
"description": "The effective start date of the product charge definition.\n"
},
"financeInformation": {
"type": "object",
"title": "financeInformation",
"properties": {
"contractAssetAccountingCode": {
"type": "string",
"description": "The accounting code for contract asset. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for deferred revenue, such as Monthly Recurring Liability.\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment revenue. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"contractAssetAccountingCodeType": {
"type": "string",
"description": "The type associated with the contract asset accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for contract liability. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n"
},
"accountsReceivableAccountingCode": {
"type": "string",
"nullable": true,
"description": "The accounting code for accounts receivable.\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment liability. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"deferredRevenueAccountingCodeType": {
"type": "string",
"nullable": true,
"description": "The type associated with the deferred revenue accounting code, such as Deferred Revenue. \n"
},
"unbilledReceivablesAccountingCode": {
"type": "string",
"description": "The accounting code for unbilled receivables. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"adjustmentRevenueAccountingCodeType": {
"type": "string",
"nullable": true,
"description": "The type associated with the adjustment revenue accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"contractLiabilityAccountingCodeType": {
"type": "string",
"description": "The type associated with the contract liability accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"recognizedRevenueAccountingCodeType": {
"type": "string",
"nullable": true,
"description": "The type associated with the recognized revenue accounting code, such as Sales Revenue or Sales Discount.\n"
},
"accountsReceivableAccountingCodeType": {
"type": "string",
"nullable": true,
"description": "The type of the accounting code for accounts receivable.\n"
},
"adjustmentLiabilityAccountingCodeType": {
"type": "string",
"nullable": true,
"description": "The type associated with the adjustment liability accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"unbilledReceivablesAccountingCodeType": {
"type": "string",
"description": "The type associated with the unbilled receivables accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for contract recognized revenue. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"contractRecognizedRevenueAccountingCodeType": {
"type": "string",
"description": "The type associated with the contract recognized revenue accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
}
},
"description": "Container for finance information of the rate plan charge.\n"
},
"priceIncreaseOption": {
"enum": [
"FromTenantPercentageValue",
"SpecificPercentageValue"
],
"type": "string",
"description": "Applies an automatic price change when a termed subscription is renewed.\n"
},
"productRatePlanName": {
"type": "string",
"nullable": true,
"description": "Th name of the product rate plan that uses this charge definition.\n"
},
"isAllocationEligible": {
"type": "boolean",
"description": "Indicates whether the charge segment is allocation eligible in revenue recognition. The default value is `false`.\n\n**Values**: `true`, `false`\n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled.\n"
},
"productRatePlanNumber": {
"type": "string",
"nullable": true,
"description": "The unique number (natural key) of the product rate plan that uses this charge definition.\n"
},
"specificBillingPeriod": {
"type": "number",
"nullable": true,
"description": "The specific number of billing period for the product charge definition.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"nullable": true,
"description": "The number of months for the list price base of the charge definition. \nThis field is `null` if the `listPriceBase` field is not set to `Per_Specific_Months`.\n"
},
"billingPeriodAlignment": {
"enum": [
"AlignToCharge",
"AlignToSubscriptionStart",
"AlignToTermStart",
"AlignToTermEnd"
],
"type": "string",
"description": "The billing period alignment setting for the charge.\n"
},
"revRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate",
null
],
"type": "string",
"nullable": true,
"description": "Indicates when revenue recognition begins.\n"
},
"priceIncreasePercentage": {
"type": "number",
"format": "double",
"nullable": true,
"description": "Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the `priceIncreaseOption` value to `SpecificPercentageValue`.\n\n**Character limit**: 16\n\n**Values**: a decimal value between -100 and 100\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The unique ID of the product charge of the charge definition.\n"
},
"usageRecordRatingOption": {
"enum": [
"EndOfBillingPeriod",
"OnDemand",
null
],
"type": "string",
"default": "EndOfBillingPeriod",
"nullable": true,
"description": "Determines how Zuora processes usage records for per-unit usage charges.\n"
},
"overageCalculationOption": {
"enum": [
"EndOfSmoothingPeriod",
"PerBillingPeriod",
null
],
"type": "string",
"nullable": true,
"description": "Determines when to calculate overage charges. If the value of the `SmoothingMode` field is not specified, the value of this field is ignored.\n\n**Values**: \n - `EndOfSmoothingPeriod`: This option is used by default. The overage is charged at the end of the smoothing period.\n - `PerBillingPeriod`: The overage is charged on-demand rather than waiting until the end of the smoothing period.\n"
},
"recognizedRevenueAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the recognized revenue account for this charge.\n - Required when the Allow Blank Accounting Code setting is No.\n - Optional when the Allow Blank Accounting Code setting is Yes.\n\n 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"
},
"revenueRecognitionTiming": {
"enum": [
"Upon Billing Document Posting Date",
"Upon Order Activation Date"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue recognition timing.\n\nPredefined options are listed as enum values in this API Reference. \nOther options might also be avaliable depending on \nthe <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"productChargeDefinitionId": {
"type": "string",
"description": "The unique ID of the product charge definition.\n"
},
"revenueAmortizationMethod": {
"enum": [
"Immediate",
"Ratable Using Start And End Dates"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue amortization method.\n\nPredefined options are listed as enum values in this API Reference. \nOther options might also be avaliable depending on \nthe <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"revenueRecognitionRuleName": {
"enum": [
"Recognize upon invoicing",
"Recognize daily over time"
],
"type": "string",
"description": "Determines when to recognize the revenue for this charge.\n"
},
"productDiscountApplyDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETProductDiscountApplyDetailsType"
},
"description": "Container for the application details about a discount product rate plan charge. \n\nOnly discount product rate plan charges have values for this field.\n"
},
"productRatePlanChargeNumber": {
"type": "string",
"nullable": true,
"description": "The unique number (natural key) of the product charge of the charge definition.\n"
},
"productChargeDefinitionNumber": {
"type": "string",
"description": "The unique number (natural key) of the product charge definition.\n"
},
"overageUnusedUnitsCreditOption": {
"enum": [
"NoCredit",
"CreditBySpecificRate",
null
],
"type": "string",
"nullable": true,
"description": "Determines whether to credit the customer with unused units of usage.\n"
},
"useTenantDefaultForPriceChange": {
"type": "boolean",
"description": "Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal. \n\n**Character limit**: 5\n\n**Values**: `true`, `false`\n"
},
"useDiscountSpecificAccountingCode": {
"type": "boolean",
"nullable": true,
"description": "Determines whether to define a new accounting code for the new discount charge.\n\n**Character limit**: 5\n\n**Values**: `true`, `false`\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related rate plan charges and order line items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.\n"
}
}
},
"description": "The list of the product charge definitions that are retrieved.\n"
}
}
}
GETProductDiscountApplyDetailsType
{
"type": "object",
"title": "productDiscountApplyDetails",
"properties": {
"appliedProductRatePlanId": {
"type": "string",
"description": "The ID of the product rate plan that the discount product rate plan charge applies to.\n"
},
"appliedProductRatePlanChargeId": {
"type": "string",
"description": "The ID of the product rate plan charge that the discount product rate plan charge applies to.\n"
}
}
}
GETProductRatePlanChargeDeliverySchedule
{
"type": "object",
"title": "deliverySchedule",
"properties": {
"friday": {
"type": "boolean",
"description": "The flag to indicate should the delivery happen on Friday\n"
},
"monday": {
"type": "boolean",
"description": "The flag to indicate should the delivery happen on Monday\n"
},
"sunday": {
"type": "boolean",
"description": "The flag to indicate should the delivery happen on Sunday\n"
},
"tuesday": {
"type": "boolean",
"description": "The flag to indicate should the delivery happen on Tuesday\n"
},
"saturday": {
"type": "boolean",
"description": "The flag to indicate should the delivery happen on Saturday\n"
},
"thursday": {
"type": "boolean",
"description": "The flag to indicate should the delivery happen on Thursday\n"
},
"frequency": {
"enum": [
"Weekly"
],
"type": "string",
"description": "The frequency of the delivery. Only supports weekly now\n"
},
"wendesday": {
"type": "boolean",
"description": "The flag to indicate should the delivery happen on Wendesday\n"
}
},
"description": "The delivery schedule information of this charge. Only when this charge is using Delivery Pricing charge model\n"
}
GETProductRatePlanChargePricingTierType
{
"type": "object",
"title": "tiers",
"properties": {
"tier": {
"type": "integer",
"format": "int64",
"description": "Unique number of the tier.\n"
},
"price": {
"type": "string",
"format": "decimal",
"description": "The decimal value of the tiered charge model. If the charge model is not a tiered type then this price field will be null and the price field directly under the productRatePlanCharges applies.\n"
},
"endingUnit": {
"type": "string",
"format": "decimal",
"description": "Decimal defining end of tier range.\n"
},
"priceFormat": {
"type": "string",
"description": "Tier price format.\n\nAllowed values:\n- flat fee \n- per unit\n"
},
"startingUnit": {
"type": "string",
"format": "decimal",
"description": "Decimal defining start of tier range.\n"
}
}
}
GETProductRatePlanChargePricingType
{
"type": "object",
"title": "pricing",
"properties": {
"price": {
"type": "string",
"format": "decimal",
"description": "The decimal value that applies when the charge model is not tiered\n"
},
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETProductRatePlanChargePricingTierType"
},
"description": "Container for one or many defined tier ranges with distinct pricing. Applies when model is `Tiered`, `TieredWithOverage`, or `Volume`\n"
},
"currency": {
"type": "string",
"description": "Currency used by the charge model. For example: USD or EUR\n"
},
"overagePrice": {
"type": "string",
"format": "decimal",
"description": "Price per unit when base set of units is exceeded. Used only when charge model is Overage or Tiered with Overage.\n"
},
"includedUnits": {
"type": "string",
"format": "decimal",
"description": "Specifies the number of units in the base set of units when the charge model is Overage.\n"
},
"discountAmount": {
"type": "string",
"format": "decimal",
"description": "Value subtracted from price in currency specified. Used only when the charge model is DiscountFixedAmount.\n"
},
"discountPercentage": {
"type": "string",
"format": "decimal",
"description": "Percent discount applied to the price. Used only when the charge model is DiscountPercentage.\n"
}
}
}
GETProductRatePlanChargeResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the product rate plan charge.\n"
},
"uom": {
"type": "string",
"nullable": true,
"description": "Indicates the units of measure (UOM) that is configured in **Settings > Billing** for the product rate plan charge.\n"
},
"name": {
"type": "string",
"description": "The name of the product rate plan charge.\n"
},
"type": {
"enum": [
"OneTime",
"Recurring",
"Usage"
],
"type": "string",
"description": "Specifies the type of charge.\n"
},
"model": {
"enum": [
"DiscountFixedAmount",
"DiscountPercentage",
"FlatFee",
"PerUnit",
"Overage",
"Tiered",
"TieredwithOverage",
"Volume",
"Delivery",
"MultiAttributePricing",
"PreratedPerUnit",
"PreratedPricing",
"HighWatermarkVolumePricing",
"HighWatermarkTieredPricing"
],
"type": "string",
"description": "Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n"
},
"formula": {
"type": "string",
"description": "The price lookup formula defined for the product rate plan charge, which is used to identify\nthe correct and relevant charge definition based on the context.\n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing/Price_lookup_in_Attribute-based_Pricing\" target=\"_blank\">Price lookup in Attribute-based Pricing</a>.\n\n\n**Note**: This field is available only if the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing\" target=\"_blank\">Attribute-based Pricing</a> feature is enabled.\n"
},
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETRatePlanChargePricing"
},
"description": "Container for the prices of the product rate plan charge.\n"
},
"success": {
"type": "boolean",
"description": "Indicates whether the request succeeded.\n"
},
"taxCode": {
"type": "string",
"maxLength": 64,
"description": "Specifies the tax code for taxation rules. This field is required when the `taxable` field is set to `true`.\n\n**Note**: This value affects the tax calculation of the rate plan charge.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive",
null
],
"type": "string",
"nullable": true,
"description": "Determines how to define taxation for the charge. This field is required when the `taxable` field is set to `true`.\n\n**Note**: This value affects the tax calculation of the rate plan charge.\n"
},
"taxable": {
"type": "boolean",
"description": "Determines whether the charge is taxable. When set to `true`, the `taxMode` and `taxCode` fields are required when creating or updating th Product Rate Plan Charge object.\n\n**Character limit**: 5\n\n**Values**: `true`, `false`\n\n**Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.\n"
},
"isPrepaid": {
"type": "boolean",
"description": "Indicates whether this charge is a prepayment (topup) charge or a\ndrawdown charge.\n\n**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled.\n\n**Values**: `true` or `false`.\n"
},
"billingDay": {
"type": "string",
"description": "The bill cycle type for this charge.\n"
},
"isRollover": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe value is either \"true\" or \"false\". It determines whether the rollover fields are needed.\n"
},
"isUnbilled": {
"type": "boolean",
"description": "Specifies how to perform the accounting during revenue recognition. The default value is `false`.\n\n**Values**: `true`, `false`\n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled. \n"
},
"prepaidUom": {
"type": "string",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nUnit of measurement for a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"revRecCode": {
"type": "string",
"nullable": true,
"maxLength": 70,
"description": "Associates this product rate plan charge with a specific revenue recognition code.\n"
},
"description": {
"type": "string",
"description": "The description for this charge.\n"
},
"drawdownUom": {
"type": "string",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nUnit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).\n"
},
"productLine": {
"type": "string",
"description": "This field is used to maintain the product line for integration with Zuora Revenue. \n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled.\n"
},
"ratingGroup": {
"enum": [
"ByBillingPeriod",
"ByUsageStartDate",
"ByUsageRecord",
"ByUsageUpload",
"ByGroupId",
null
],
"type": "string",
"default": "ByBillingPeriod",
"nullable": true,
"description": "Specifies a rating group based on which usage records are rated.\n\nPossible values: \n - `ByBillingPeriod`: The rating is based on all the usages in a billing period. \n - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. \n - `ByUsageRecord`: The rating is based on each usage record.\n - `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`).\n - `ByGroupId`: The rating is based on all the usages in a custom group.\n\n**Notes:** \n - The `ByBillingPeriod` value can be applied for all charge models. \n - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. \n - The `ByGroupId` value is only available if you have the Active Rating feature enabled.\n - Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`.\n"
},
"upToPeriods": {
"type": "number",
"nullable": true,
"description": "The number of up-to-periods value for this charge.\n"
},
"creditOption": {
"enum": [
"TimeBased",
"ConsumptionBased",
"FullCreditBack"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe way to calculate credit. See [Credit Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option) for more information. \n"
},
"customFields": {
"$ref": "#/components/schemas/ProductRatePlanChargeObjectCustomFields"
},
"drawdownRate": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).\n"
},
"productClass": {
"type": "string",
"description": "This field is used to maintain the product class for integration with Zuora Revenue. \n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled. \n"
},
"triggerEvent": {
"enum": [
"ContractEffective",
"ServiceActivation",
"CustomerAcceptance"
],
"type": "string",
"description": "Specifies when to start billing the customer for the charge.\n\n**Values**:\n - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.\n - `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access.\n - `CustomerAcceptance` is when the customer accepts the services or products for a subscription.\n"
},
"billingPeriod": {
"type": "string",
"description": "The billing period for this charge.\n"
},
"billingTiming": {
"enum": [
"IN_ADVANCE",
"IN_ARREARS"
],
"type": "string",
"description": "The billing timing for this charge.\n"
},
"discountClass": {
"type": "string",
"nullable": true,
"description": "The class that the discount belongs to. The discount class defines the order in which discount product rate plan charges are applied.\n\nFor more information, see [Manage Discount Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).\n"
},
"discountLevel": {
"enum": [
"rateplan",
"subscription",
"account",
null
],
"type": "string",
"nullable": true,
"description": "The application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year"
],
"type": "string",
"description": "The base of list price. \n\nThis field is applicable only for recurring charges.\n\n**Note**: The `Per_Year` enum value is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n"
},
"productFamily": {
"type": "string",
"description": "This field is used to maintain the product family for integration with Zuora Revenue. \n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled.\n"
},
"rolloverApply": {
"enum": [
"ApplyFirst",
"ApplyLast"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the priority of rollover, which is either first or last.\n"
},
"chargeFunction": {
"enum": [
"Standard",
"Prepayment",
"CommitmentTrueUp",
"Drawdown",
"CreditCommitment",
"DrawdownAndCreditCommitment"
],
"type": "string",
"description": "**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage\" target=\"_blank\">Unbilled Usage</a> feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to `141` or higher. Otherwise, an error occurs.\n\nThis field defines what type of charge it is in Advanced Consumption Billing:\n* Standard: Normal charge with no Prepayment or Commitment or Drawdown.\n* Prepayment: For recurring charges. Unit or currency based prepaid charge.\n* CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge.\n* Drawdown: For usage charges. Drawdown from prepaid funds.\n* DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds.\n* CreditCommitment: For usage charges. Credit to minimum commitment funds.\n"
},
"commitmentType": {
"enum": [
"UNIT",
"CURRENCY"
],
"type": "string",
"description": "**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage\" target=\"_blank\">Unbilled Usage</a> feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to `133` or higher. Otherwise, an error occurs. \n\nThis field defines the type of commitment. A prepaid charge can be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can only be `CURRENCY` type. For topup(recurring or one-time) charges, this field indicates what type of funds are created. \n* If UNIT, it will create a fund with given prepaidUom.\n* If CURRENCY, it will create a fund with the currency amount calculated in list price.\n \nFor drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges.\n"
},
"numberOfPeriod": {
"type": "integer",
"format": "int64",
"description": "Indicates the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number.\n"
},
"pricingSummary": {
"type": "array",
"items": {
"type": "string"
},
"description": "A concise description of the charge model and pricing that is suitable to show to your customers. \n\nWhen the rate plan charge model is `Tiered` and multi-currency is enabled, this field includes an array of string of each currency, and each string of currency includes tier price description separated by comma.\n\nFor the following charge models, the value of this field is an empty string:\n- Multi-Attribute Pricing\n- High Water Mark Tiered Pricing\n- High Water Mark Volume Pricing\n- Pre-Rated Per Unit Pricing\n- Pre-Rated Pricing\n\nThe charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
},
"smoothingModel": {
"enum": [
"RollingWindow",
"Rollover",
null
],
"type": "string",
"nullable": true,
"description": "Specifies the smoothing model for an overage smoothing charge model.\n"
},
"applyDiscountTo": {
"enum": [
"ONETIME",
"RECURRING",
"USAGE",
"ONETIMERECURRING",
"ONETIMEUSAGE",
"RECURRINGUSAGE",
"ONETIMERECURRINGUSAGE",
null
],
"type": "string",
"nullable": true,
"description": "Indicates which type of charge the discount charge applies to.\n"
},
"defaultQuantity": {
"type": "number",
"nullable": true,
"description": "The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n"
},
"numberOfPeriods": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Specifies the number of periods to use when calculating charges in an overage smoothing charge model.\nThis field is ued when overage smoothing model is `RollingWindow` or `Rollover`.\n"
},
"prepaidQuantity": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).\n"
},
"productCategory": {
"type": "string",
"description": "This field is used to maintain the product category for integration with Zuora Revenue. \n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled. \n"
},
"rolloverPeriods": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the number of rollover periods, it is restricted to 3.\n"
},
"upToPeriodsType": {
"enum": [
"Billing_Periods",
"Days",
"Weeks",
"Months",
"Years",
null
],
"type": "string",
"nullable": true,
"description": "The up-to-periods type setting for this charge.\n"
},
"deliverySchedule": {
"$ref": "#/components/schemas/GETDeliverySchedule"
},
"endDateCondition": {
"enum": [
"Subscription_End",
"One_Time",
"Fixed_Period",
"Specific_End_Date"
],
"type": "string",
"description": "The end date condition for this charge.\n"
},
"isStackedDiscount": {
"type": "boolean",
"description": "**Note**: This field is only applicable to the Discount - Percentage charge model.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 130 or higher. Otherwise, an error occurs.\n\nThis field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:\n - `true`: This is a stacked discount, which should be calculated by stacking with other discounts.\n - `false`: This is not a stacked discount, which should be calculated in sequence with other discounts.\n\nFor more information, see [Stacked discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).\n"
},
"priceChangeOption": {
"enum": [
"NoChange",
"SpecificPercentageValue",
"UseLatestProductCatalogPricing",
null
],
"type": "string",
"default": "NoChange",
"nullable": true,
"description": "Applies an automatic price change when a termed subscription is renewed.\n"
},
"financeInformation": {
"type": "object",
"title": "financeInformation",
"properties": {
"contractAssetAccountingCode": {
"type": "string",
"description": "The accounting code for contract asset. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for deferred revenue, such as Monthly Recurring Liability.\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment revenue. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"contractAssetAccountingCodeType": {
"type": "string",
"description": "The type associated with the contract asset accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for contract liability. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for recognized revenue, such as Monthly Recurring Charges or Overage Charges. \n"
},
"accountsReceivableAccountingCode": {
"type": "string",
"nullable": true,
"description": "The accounting code for accounts receivable.\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment liability. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"deferredRevenueAccountingCodeType": {
"type": "string",
"nullable": true,
"description": "The type associated with the deferred revenue accounting code, such as Deferred Revenue. \n"
},
"unbilledReceivablesAccountingCode": {
"type": "string",
"nullable": true,
"description": "The accounting code for unbilled receivables. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"adjustmentRevenueAccountingCodeType": {
"type": "string",
"description": "The type associated with the adjustment revenue accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"contractLiabilityAccountingCodeType": {
"type": "string",
"description": "The type associated with the contract liability accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"recognizedRevenueAccountingCodeType": {
"type": "string",
"nullable": true,
"description": "The type associated with the recognized revenue accounting code, such as Sales Revenue or Sales Discount.\n"
},
"accountsReceivableAccountingCodeType": {
"type": "string",
"nullable": true,
"description": "The type of the accounting code for accounts receivable.\n"
},
"adjustmentLiabilityAccountingCodeType": {
"type": "string",
"description": "The type associated with the adjustment liability accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"unbilledReceivablesAccountingCodeType": {
"type": "string",
"description": "The type associated with the unbilled receivables accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for contract recognized revenue. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
},
"contractRecognizedRevenueAccountingCodeType": {
"type": "string",
"description": "The type associated with the contract recognized revenue accounting code. \n\n**Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled.\n"
}
},
"description": "Container for the finance information of a product rate plan charge.\n"
},
"validityPeriodType": {
"enum": [
"SUBSCRIPTION_TERM",
"ANNUAL",
"SEMI_ANNUAL",
"QUARTER",
"MONTH"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"priceIncreaseOption": {
"enum": [
"FromTenantPercentageValue",
"SpecificPercentageValue"
],
"type": "string",
"description": "Applies an automatic price change when a termed subscription is renewed.\n"
},
"isAllocationEligible": {
"type": "boolean",
"description": "Indicates whether the charge segment is allocation eligible in revenue recognition. The default value is `false`.\n\n**Values**: `true`, `false`\n\n**Note**: This field is available only if you have the Additional Revenue Fields property enabled.\n"
},
"prepaidOperationType": {
"enum": [
"topup",
"drawdown",
null
],
"type": "string",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe type of this charge. It is either a prepayment (topup) charge or a drawdown charge. \n"
},
"prepaidTotalQuantity": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"rolloverPeriodLength": {
"type": "integer",
"default": null,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period length of the rollover fund.\n"
},
"specificBillingPeriod": {
"type": "number",
"nullable": true,
"description": "The specific number of billing periods for this charge.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"nullable": true,
"description": "The number of months for the list price base of the charge. The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.\n"
},
"billingPeriodAlignment": {
"enum": [
"AlignToCharge",
"AlignToSubscriptionStart",
"AlignToTermStart",
"AlignToTermEnd"
],
"type": "string",
"description": "The billing period alignment setting for this charge.\n"
},
"revRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate",
null
],
"type": "string",
"nullable": true,
"description": "Specifies when revenue recognition begins.\n"
},
"priceIncreasePercentage": {
"type": "number",
"format": "double",
"nullable": true,
"description": "Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the `priceIncreaseOption` field to `SpecificPercentageValue`.\n\n**Character limit**: 16\n\n**Values**: a decimal value between -100 and 100\n"
},
"usageRecordRatingOption": {
"enum": [
"EndOfBillingPeriod",
"OnDemand",
null
],
"type": "string",
"default": "EndOfBillingPeriod",
"nullable": true,
"description": "Determines how Zuora processes usage records for per-unit usage charges.\n"
},
"overageCalculationOption": {
"enum": [
"EndOfSmoothingPeriod",
"PerBillingPeriod",
null
],
"type": "string",
"nullable": true,
"description": "Determines when to calculate overage charges. If the value of the `smoothingMode` field is not specified, the value of this field is ignored.\n\n**Values**: \n - `EndOfSmoothingPeriod`: This option is used by default. The overage is charged at the end of the smoothing period.\n - `PerBillingPeriod`: The overage is charged on-demand rather than waiting until the end of the smoothing period.\n"
},
"productChargeDefinitions": {
"type": "string",
"description": "A link to retrieve product charge definitions of this charge.\n"
},
"recognizedRevenueAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the recognized revenue account for this charge.\n - Required when the Allow Blank Accounting Code setting is No.\n - Optional when the Allow Blank Accounting Code setting is Yes.\n\n 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"
},
"revenueRecognitionTiming": {
"enum": [
"Upon Billing Document Posting Date",
"Upon Order Activation Date"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue recognition timing.\n\nPredefined options are listed as enum values in this API Reference. \nOther options might also be avaliable depending on \nthe <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"revenueAmortizationMethod": {
"enum": [
"Immediate",
"Ratable Using Start And End Dates"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue amortization method.\n\nPredefined options are listed as enum values in this API Reference. \nOther options might also be avaliable depending on \nthe <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"revenueRecognitionRuleName": {
"enum": [
"Recognize upon invoicing",
"Recognize daily over time"
],
"type": "string",
"description": "Determines when to recognize the revenue for this charge.\n"
},
"productDiscountApplyDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETProductDiscountApplyDetailsType"
},
"description": "Container for the application details about a discount product rate plan charge. \n\nOnly discount product rate plan charges have values in this field.\n"
},
"productRatePlanChargeNumber": {
"type": "string",
"nullable": true,
"description": "The number of this product rate plan charge.\n"
},
"applyToBillingPeriodPartially": {
"type": "boolean",
"description": "Allow the discount duration to be aligned with the billing period partially.\n\n**Note**: You must enable the [Enhanced Discount](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.\n"
},
"overageUnusedUnitsCreditOption": {
"enum": [
"NoCredit",
"CreditBySpecificRate",
null
],
"type": "string",
"nullable": true,
"description": "Determines whether to credit the customer with unused units of usage.\n"
},
"useTenantDefaultForPriceChange": {
"type": "boolean",
"description": "Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal. \n\n**Character limit**: 5\n\n**Values**: `true`, `false`\n"
},
"useDiscountSpecificAccountingCode": {
"type": "boolean",
"nullable": true,
"description": "Determines whether to define a new accounting code for the new discount charge.\n\n**Character limit**: 5\n\n**Values**: `true`, `false`\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related rate plan charges and order line items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.\n"
}
}
}
GETProductRatePlanChargeType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique product rate-plan charge ID.\n"
},
"uom": {
"type": "string",
"nullable": true,
"description": "Describes the Units of Measure (uom) configured in **Settings > Billing** for the productRatePlanCharges.\n\nValues: `Each`, `License`, `Seat`, or `null`\n"
},
"name": {
"type": "string",
"description": "Name of the product rate-plan charge. (Not required to be unique.)\n"
},
"type": {
"type": "string",
"description": "The type of charge. Possible values are: `OneTime`, `Recurring`, `Usage`.\n"
},
"model": {
"type": "string",
"description": "Charge model which determines how charges are calculated. Charge models must be individually activated in Zuora Billing administration. \n\nPossible values are:\n- `FlatFee`\n- `PerUnit`\n- `Overage`\n- `Volume`\n- `Tiered`\n- `TieredWithOverage`\n- `DiscountFixedAmount`\n- `DiscountPercentage`\n- `Delivery` (available only if you have the Delivery Pricing charge model enabled)\n- `MultiAttributePricing` (available only if you have the Multi-Attribute Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.)\n- `PreratedPerUnit` (available only if you have the Pre-rated Per Unit Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.)\n- `PreratedPricing` (available only if you have the Pre-rated Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.)\n- `HighWatermarkVolumePricing` (available only if you have the High Water Mark Volume Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.)\n- `HighWatermarkTieredPricing` (available only if you have the High Water Mark Tiered Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.)\n\nThe value of the `pricing` field contains details about these charge models and the value of `pricingSummary` field contains their associated pricing summary values.\n"
},
"formula": {
"type": "string",
"description": "The pricing formula to calculate the actual rating amount for each usage record.\n\nThis field is only available for the usage-based charges that use the Multi-Attribute Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
},
"pricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETProductRatePlanChargePricingType"
},
"description": "One or more price charge models with attributes that further describe the model. \nSome attributes show as null values when not applicable.\n"
},
"taxCode": {
"type": "string",
"description": "Specifies the tax code for taxation rules; used by Zuora Tax.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive",
null
],
"type": "string",
"nullable": true,
"description": "Specifies how to define taxation for the charge; used by Zuora Tax.\n"
},
"taxable": {
"type": "boolean",
"description": "Specifies whether the charge is taxable; used by Zuora Tax. Possible values are:`true`, `false`.\n"
},
"isPrepaid": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nIndicates whether this charge is a prepayment (topup) charge or a drawdown charge. Values: `true` or `false`.\n"
},
"billingDay": {
"type": "string",
"description": "The bill cycle day (BCD) for the charge. The BCD determines which day of the month or week the customer is billed. The BCD value in the account can override the BCD in this object.\n"
},
"isRollover": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe value is either \"true\" or \"false\". It determines whether the rollover fields are needed.\n"
},
"isUnbilled": {
"type": "boolean",
"description": "This field is used to dictate how to perform the accounting during revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"prepaidUom": {
"type": "string",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nUnit of measurement for a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"revRecCode": {
"type": "string",
"nullable": true,
"maxLength": 70,
"description": "Associates this product rate plan charge with a specific revenue recognition code. The value is a valid revenue recognition code.\n"
},
"description": {
"type": "string",
"description": "Usually a brief line item summary of the Rate Plan Charge.\n"
},
"drawdownUom": {
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nUnit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).\n"
},
"maxQuantity": {
"type": "string",
"format": "decimal",
"description": "Specifies the maximum number of units for this charge. Use this field and the `minQuantity` field to create a range of units allowed in a product rate plan charge.\n"
},
"minQuantity": {
"type": "string",
"format": "decimal",
"description": "Specifies the minimum number of units for this charge. Use this field and the `maxQuantity` field to create a range of units allowed in a product rate plan charge.\n"
},
"ratingGroup": {
"type": "string",
"nullable": true,
"description": "Specifies a rating group based on which usage records are rated.\n\nPossible values:\n\n- `ByBillingPeriod` (default): The rating is based on all the usages in a billing period.\n- `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. \n- `ByUsageRecord`: The rating is based on each usage record.\n- `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`).\n- `ByGroupId`: The rating is based on all the usages in a custom group.\n\n**Note:** \n- The `ByBillingPeriod` value can be applied for all charge models. \n- The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. \n- The `ByGroupId` value is only available if you have the Active Rating feature enabled.\n- Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`.\n"
},
"upToPeriods": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.\nIf the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.\n"
},
"creditOption": {
"enum": [
"TimeBased",
"ConsumptionBased",
"FullCreditBack"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe way to calculate credit. See [Credit Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option) for more information. \n"
},
"drawdownRate": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).\n"
},
"triggerEvent": {
"type": "string",
"description": "Specifies when to start billing the customer for the charge.\n\nValues: one of the following:\n- `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.\n- `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access.\n- `CustomerAcceptance` is when the customer accepts the services or products for a subscription. \n- `SpecificDate` is the date specified.\n"
},
"billingPeriod": {
"type": "string",
"description": "The billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD).\n\nValues:\n- Month\n- Quarter\n- Annual\n- Semi_Annual\n- Specific Months\n- Week\n- Specific_Weeks\n"
},
"billingTiming": {
"type": "string",
"description": "The billing timing for the charge. You can choose to bill for charges in advance or in arrears.\n\nValues:\n- In Advance\n- In Arrears\n\n**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). \n"
},
"discountClass": {
"type": "string",
"nullable": true,
"description": "The class that the discount belongs to. The discount class defines the order in which discount product rate plan charges are applied.\n\nFor more information, see [Manage Discount Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).\n"
},
"discountLevel": {
"type": "string",
"nullable": true,
"description": "The level of the discount. \n\nValues:\n- RatePlan\n- Subscription\n- Account\n"
},
"includedUnits": {
"type": "string",
"format": "decimal",
"description": "Specifies the number of units in the base set of units when the charge model is Overage.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year",
"Per_Specific_Months"
],
"type": "string",
"description": "The list price base for the product rate plan charge.\n\nThis field is only applicable for recurring charges.\n"
},
"prepayPeriods": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "The number of periods to which prepayment is set. \n\n**Note:** This field is only available if you already have the prepayment feature enabled. The prepayment feature is deprecated and available only for backward compatibility. Zuora does not support enabling this feature anymore.\n"
},
"rolloverApply": {
"enum": [
"ApplyFirst",
"ApplyLast"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the priority of rollover, which is either first or last.\n"
},
"pricingSummary": {
"type": "array",
"items": {
"type": "string"
},
"description": "A concise description of the charge model and pricing that is suitable to show to your customers. When the rate plan charge model is `Tiered` and multi-currency is enabled, this field includes an array of string of each currency, and each string of currency includes tier price description separated by comma.\n\nFor the following charge models, the value of this field is an empty string:\n- Multi-Attribute Pricing\n- High Water Mark Tiered Pricing\n- High Water Mark Volume Pricing\n- Pre-Rated Per Unit Pricing\n- Pre-Rated Pricing\n\nThe charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
},
"smoothingModel": {
"type": "string",
"nullable": true,
"description": "Specifies the smoothing model for an overage smoothing charge model or an tiered with overage model, which is an advanced type of a usage model that avoids spikes in usage charges. If a customer's usage spikes in a single period, then an overage smoothing model eases overage charges by considering usage and multiple periods.\n\nOne of the following values shows which smoothing model will be applied to the charge when `Overage` or `Tiered with Overage` is used:\n\n- `RollingWindow` considers a number of periods to smooth usage. The rolling window starts and increments forward based on billing frequency. When allowed usage is met, then period resets and a new window begins.\n- `Rollover` considers a fixed number of periods before calculating usage. The net balance at the end of a period is unused usage, which is carried over to the next period's balance.\n"
},
"applyDiscountTo": {
"type": "string",
"description": "Specifies where (to what charge type) the discount will be applied. These field values are case-sensitive.\n\nPermissible values:\n- RECURRING\n- USAGE\n- ONETIMERECURRING\n- ONETIMEUSAGE\n- RECURRINGUSAGE\n- ONETIMERECURRINGUSAGE\n"
},
"defaultQuantity": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "The default quantity of units. This field is required if you use a per-unit charge model.\n"
},
"numberOfPeriods": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Specifies the number of periods to use when calculating charges in an overage smoothing charge model. This field is ued when overage smoothing model is `RollingWindow` or `Rollover`.\n"
},
"prepaidQuantity": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).\n"
},
"rolloverPeriods": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the number of rollover periods, it is restricted to 3.\n"
},
"upToPeriodsType": {
"enum": [
"Billing_Periods",
"Days",
"Weeks",
"Months",
"Years",
null
],
"type": "string",
"nullable": true,
"description": "The period type used to define when the charge ends.\n"
},
"deliverySchedule": {
"$ref": "#/components/schemas/GETProductRatePlanChargeDeliverySchedule"
},
"endDateCondition": {
"type": "string",
"description": "Defines when the charge ends after the charge trigger date. If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date.\n\nValues:\n- Subscription_End\n- Fixed_Period\n"
},
"isStackedDiscount": {
"type": "boolean",
"description": "**Note**: This field is only applicable to the Discount - Percentage charge model.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 130 or higher. Otherwise, an error occurs.\n\nThis field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:\n\n- `true`: This is a stacked discount, which should be calculated by stacking with other discounts.\n\n- `false`: This is not a stacked discount, which should be calculated in sequence with other discounts.\n\nFor more information, see [Stacked discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).\n"
},
"priceChangeOption": {
"type": "string",
"nullable": true,
"description": "Applies an automatic price change when a termed subscription is renewed and the following applies:\n\n1. AutomatedPriceChange setting is on\n2. Charge type is not one-time\n3. Charge model is not discount fixed amount\n\nValues:\n- NoChange (default)\n- SpecificPercentageValue\n- UseLatestProductCatalogPricing\n"
},
"financeInformation": {
"type": "object",
"title": "financeInformation",
"properties": {
"contractAssetAccountingCode": {
"type": "string",
"description": "The accounting code for contract asset. \n\n**Note**: This field is only available if you have the RevPro Integration feature enabled. \n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for deferred revenue, such as Monthly Recurring Liability. \n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment revenue. \n\n**Note**: This field is only available if you have the RevPro Integration feature enabled. \n"
},
"contractAssetAccountingCodeType": {
"type": "string",
"description": "The type associated with the contract asset accounting code. \n\n**Note**: This field is only available if you have the RevPro Integration feature enabled.\n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for contract liability. \n\n**Note**: This field is only available if you have the RevPro Integration feature enabled. \n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for recognized revenue, such as Monthly Recurring Charges or Overage Charges. \n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment liability. \n\n**Note**: This field is only available if you have the RevPro Integration feature enabled. \n"
},
"deferredRevenueAccountingCodeType": {
"type": "string",
"nullable": true,
"description": "The type associated with the deferred revenue accounting code, such as Deferred Revenue. \n"
},
"unbilledReceivablesAccountingCode": {
"type": "string",
"description": "The accounting code for unbilled receivables. \n\n**Note**: This field is only available if you have the RevPro Integration feature enabled. \n"
},
"adjustmentRevenueAccountingCodeType": {
"type": "string",
"description": "The type associated with the adjustment revenue accounting code. \n\n**Note**: This field is only available if you have the RevPro Integration feature enabled.\n"
},
"contractLiabilityAccountingCodeType": {
"type": "string",
"description": "The type associated with the contract liability accounting code. \n\n**Note**: This field is only available if you have the RevPro Integration feature enabled.\n"
},
"recognizedRevenueAccountingCodeType": {
"type": "string",
"nullable": true,
"description": "The type associated with the recognized revenue accounting code, such as Sales Revenue or Sales Discount. \n"
},
"adjustmentLiabilityAccountingCodeType": {
"type": "string",
"description": "The type associated with the adjustment liability accounting code. \n\n**Note**: This field is only available if you have the RevPro Integration feature enabled.\n"
},
"unbilledReceivablesAccountingCodeType": {
"type": "string",
"description": "The type associated with the unbilled receivables accounting code. \n\n**Note**: This field is only available if you have the RevPro Integration feature enabled.\n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for contract recognized revenue. \n\n**Note**: This field is only available if you have the RevPro Integration feature enabled. \n"
},
"contractRecognizedRevenueAccountingCodeType": {
"type": "string",
"description": "The type associated with the contract recognized revenue accounting code. \n\n**Note**: This field is only available if you have the RevPro Integration feature enabled.\n"
}
},
"description": "Container for finance information of a rate plan charge.\n"
},
"validityPeriodType": {
"enum": [
"SUBSCRIPTION_TERM",
"ANNUAL",
"SEMI_ANNUAL",
"QUARTER",
"MONTH"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"isAllocationEligible": {
"type": "boolean",
"description": "This field is used to identify if the charge segment is allocation eligible in revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"prepaidOperationType": {
"enum": [
"topup",
"drawdown",
null
],
"type": "string",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe type of this charge. It is either a prepayment (topup) charge or a drawdown charge. \n"
},
"prepaidTotalQuantity": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"rolloverPeriodLength": {
"type": "integer",
"default": null,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period length of the rollover fund.\n"
},
"specificBillingPeriod": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "When the billing period is set to `Specific` Months then this positive integer reflects the number of months for billing period charges.\n"
},
"specificListPriceBase": {
"type": "integer",
"nullable": true,
"description": "The number of months for the list price base of the charge. The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.\n"
},
"billingPeriodAlignment": {
"type": "string",
"description": "Aligns charges within the same subscription if multiple charges begin on different dates.\n\nPossible values:\n- AlignToCharge\n- AlignToSubscriptionStart\n- AlignToTermStart\n"
},
"revRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate",
null
],
"type": "string",
"nullable": true,
"maxLength": 22,
"description": "Specifies when revenue recognition begins.\n"
},
"priceIncreasePercentage": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the `PriceChangeOption` value to `SpecificPercentageValue`.\n\n1. AutomatedPriceChange setting is on\n2. Charge type is not one-time\n3. Charge model is not discount fixed amount\n\nValues: a decimal between -100 and 100\n"
},
"usageRecordRatingOption": {
"type": "string",
"nullable": true,
"description": "Determines how Zuora processes usage records for per-unit usage charges. \n"
},
"overageCalculationOption": {
"type": "string",
"nullable": true,
"description": "Value specifies when to calculate overage charges.\n\nValues:\n- EndOfSmoothingPeriod\n- PerBillingPeriod\n- null\n"
},
"productChargeDefinitions": {
"type": "string",
"description": "A link to retrieve product charge definitions of this charge.\n"
},
"chargeModelConfigurations": {
"type": "object",
"description": "This field is for Zuora Internal Use only. See the **pricing** field for the same information as this field."
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"productDiscountApplyDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETProductDiscountApplyDetailsType"
},
"description": "Container for the application details about a discount product rate plan charge. \n\nOnly discount product rate plan charges have values in this field.\n"
},
"productRatePlanChargeNumber": {
"type": "string",
"description": "The natural key of the product rate plan charge.\n"
},
"overageUnusedUnitsCreditOption": {
"type": "string",
"nullable": true,
"description": "Determines whether to credit the customer with unused units of usage.\n\nValues:\n- NoCredit\n- CreditBySpecificRate\n"
},
"useTenantDefaultForPriceChange": {
"type": "boolean",
"description": "Shows the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal. You set the tenant uplift value in the web-based UI: **Settings > Billing > Define Default Subscription Settings**.\n\nValues: `true`, `false`\n"
},
"useDiscountSpecificAccountingCode": {
"type": "boolean",
"nullable": true,
"description": "Determines whether to define a new accounting code for the new discount charge.\nValues: `true`, `false`\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the related rate plan charges and order line items from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/ProductRatePlanChargeObjectNSFields"
},
{
"$ref": "#/components/schemas/ProductRatePlanChargeObjectCustomFields"
}
],
"title": "productRatePlanCharges"
}
GETProductRatePlanDefinitionResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the product rate plan definition.\n"
},
"success": {
"type": "boolean",
"description": "Indicates whether the request succeeded.\n"
},
"productRatePlanId": {
"type": "string",
"description": "The unique ID of the product rate plan that uses this rate plan definition.\n"
},
"productRatePlanName": {
"type": "string",
"description": "Th name of the product rate plan that uses this rate plan definition.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "The unique number (natural key) of the product rate plan that uses this rate plan definition.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The unique ID of the product charge in this rate plan definition.\n"
},
"productRatePlanChargeName": {
"type": "string",
"description": "Th name of the product charge in this rate plan definition.\n"
},
"productRatePlanChargeNumber": {
"type": "string",
"description": "The unique number (natural key) of the product charge in this rate plan definition.\n"
}
}
}
GETProductRatePlanDefinitionsResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Indicates whether the request succeeded.\n"
},
"productRatePlanDefinitions": {
"type": "array",
"items": {
"type": "object",
"title": "productRatePlanDefinitions",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the product rate plan definition.\n"
},
"productRatePlanId": {
"type": "string",
"description": "The unique ID of the product rate plan that uses this rate plan definition.\n"
},
"productRatePlanName": {
"type": "string",
"description": "Th name of the product rate plan that uses this rate plan definition.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "The unique number (natural key) of the product rate plan that uses this rate plan definition.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The unique ID of the product charge in this rate plan definition.\n"
},
"productRatePlanChargeName": {
"type": "string",
"description": "Th name of the product charge in this rate plan definition.\n"
},
"productRatePlanChargeNumber": {
"type": "string",
"description": "The unique number (natural key) of the product charge in this rate plan definition.\n"
}
}
},
"description": "The list of the product rate plan definitions that are retrieved.\n"
}
}
}
GETProductRatePlanType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique product rate-plan ID.\n"
},
"name": {
"type": "string",
"description": "Name of the product rate-plan charge. (Not required to be unique.)\n"
},
"grade": {
"type": "number",
"description": "The grade of the product rate plan.\n\n**Note**: This field is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).\n"
},
"status": {
"enum": [
"Active",
"Expired",
"NotStarted"
],
"type": "string",
"description": "The status of the product rate plan.\n"
},
"description": {
"type": "string",
"description": "Rate plan description.\n"
},
"effectiveEndDate": {
"type": "string",
"format": "date",
"description": "Final date the rate plan is active, as `yyyy-mm-dd`. After this date, the rate plan status is `Expired`.\n"
},
"effectiveStartDate": {
"type": "string",
"format": "date",
"description": "First date the rate plan is active (i.e., available to be subscribed to), as `yyyy-mm-dd`. Before this date, the status is `NotStarted`.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "The natural key of the product rate plan. \n"
},
"productRatePlanCharges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETProductRatePlanChargeType"
},
"description": "Field attributes describing the product rate plan charges:\n"
}
}
},
{
"$ref": "#/components/schemas/ProductRatePlanObjectNSFields"
},
{
"$ref": "#/components/schemas/ProductRatePlanObjectCustomFields"
}
],
"title": "productRatePlans"
}
GETProductRatePlanWithExternalIdMultiResponse
{
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"description": "The unique product rate plan ID.\n"
},
"name": {
"type": "string",
"description": "The name of the product rate plan.\n"
},
"grade": {
"type": "number",
"description": "The grade of the product rate plan.\n\n**Note**: This field is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).\n"
},
"status": {
"enum": [
"Active",
"Expired",
"NotStarted"
],
"type": "string",
"description": "The status of the product rate plan. \n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"description": {
"type": "string",
"description": "The short description of the product rate plan.\n"
},
"effectiveEndDate": {
"type": "string",
"format": "date",
"description": "The end date of the product rate plan.\n"
},
"effectiveStartDate": {
"type": "string",
"format": "date",
"description": "The start date of the product rate plan.\n"
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled. \n"
},
"ExternalIdSourceSystem": {
"type": "string",
"description": "The combination of `externallyManagedPlanId` and `externalIdSourceSystem` is the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n"
},
"externallyManagedPlanIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The unique identifier for the product rate plan in a third-party store. This field is used to represent a rate plan created through third-party stores.\n"
}
}
}
}
GETProductRatePlanWithExternalIdResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique product rate plan ID.\n"
},
"name": {
"type": "string",
"description": "The name of the product rate plan.\n"
},
"grade": {
"type": "number",
"description": "The grade of the product rate plan.\n\n**Note**: This field is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).\n"
},
"status": {
"enum": [
"Active",
"Expired",
"NotStarted"
],
"type": "string",
"description": "The status of the product rate plan. \n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"description": {
"type": "string",
"description": "The short description of the product rate plan.\n"
},
"effectiveEndDate": {
"type": "string",
"format": "date",
"description": "The end date of the product rate plan.\n"
},
"effectiveStartDate": {
"type": "string",
"format": "date",
"description": "The start date of the product rate plan.\n"
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled. \n"
},
"productRatePlanNumber": {
"type": "string",
"description": "The natural key of the product rate plan.\n"
},
"ExternalIdSourceSystem": {
"type": "string",
"description": "The combination of `externallyManagedPlanId` and `externalIdSourceSystem` is the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n"
},
"externallyManagedPlanIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The unique identifier for the product rate plan in a third-party store. This field is used to represent a rate plan created through third-party stores.\n"
}
}
}
GETProductRatePlansResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"productRatePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETProductRatePlanType"
},
"description": "Container for one or more products.\n"
}
}
}
GETProductType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Product ID.\n"
},
"sku": {
"type": "string",
"description": "Unique product SKU, up to 50 characters.\n"
},
"name": {
"type": "string",
"description": "Product name, up to 100 characters.\n"
},
"tags": {
"type": "string",
"description": ""
},
"category": {
"type": "string",
"description": "Category of the product. Used by Zuora Quotes Guided Product Selector.\n\nPossible values are:\n - Base Products\n - Add On Services\n - Miscellaneous Products\n"
},
"description": {
"type": "string",
"description": "Optional product description.\n"
},
"productNumber": {
"type": "string",
"description": "The natural key of the product.\n"
},
"productFeatures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetProductFeatureType"
},
"description": "Container for one or more product features. Only available when the following settings are enabled:\n- The Entitlements feature in your tenant\n- The Enable Feature Specification in Product and Subscriptions setting in Settings > Billing\n"
},
"effectiveEndDate": {
"type": "string",
"format": "date",
"description": "The date when the product expires and cannot be subscribed to anymore, as `yyyy-mm-dd`.\n"
},
"productRatePlans": {
"type": "string",
"format": "URL",
"description": "URL to retrieve information about all product rate plans of a specific product. For example, `/v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan`. If you want to view the product rate plan details, call [List all product rate plans of a product](https://developer.zuora.com/api-references/api/operation/GET_ProductRatePlans) with the returned URL.\n\nThis field is in Zuora REST API version control. If you set the `zuora-version` request header to `230.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version), the value of this field is a URL. Zuora recommends that you use the latest behavior to retrieve product information.\n\nIf you do not set the `zuora-version` request header or you set this header to `229.0` or earlier [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version), the value of this field is an array of product rate plan details. \nFor more information about the array, see the response body of [List all product rate plans of a product](https://developer.zuora.com/api-references/api/operation/GET_ProductRatePlans). **Note**: The array contains a maximum of 300 product rate plans. Additionally, across all product rate plans, at most 300 product rate plan charges are returned.\n"
},
"effectiveStartDate": {
"type": "string",
"format": "date",
"description": "The date when the product becomes available and can be subscribed to, as `yyyy-mm-dd`.\n"
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/ProductObjectNSFields"
},
{
"$ref": "#/components/schemas/ProductObjectCustomFields"
}
],
"title": "products"
}
GETPublicEmailTemplateResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The email template ID."
},
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the email template."
},
"active": {
"type": "boolean",
"description": "The status of the email template."
},
"isHtml": {
"type": "boolean",
"description": "Indicates whether the style of email body is HTML."
},
"fromName": {
"type": "string",
"maxLength": 50,
"description": "The name of email sender."
},
"createdBy": {
"type": "string",
"format": "uuid",
"description": "The ID of the user who created the email template."
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "The time when the email template was created. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00"
},
"emailBody": {
"type": "string",
"description": "The email body. You can add merge fields in the email body using angle brackets or double curly brackets. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates\" target=\"_blank\">Merge field syntax for email templates</a>. \n\nUser can also embed html tags if `isHtml` is `true`.\n"
},
"updatedBy": {
"type": "string",
"format": "uuid",
"description": "The ID of the user who updated the email template."
},
"updatedOn": {
"type": "string",
"format": "date-time",
"description": "The time when the email template was updated. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00"
},
"ccEmailType": {
"enum": [
"BillToContact",
"SoldToContact",
"SpecificEmails",
"TenantAdmin",
"BillToAndSoldToContacts",
"RunOwner",
"AllContacts",
"InvoiceOwnerBillToContact",
"InvoiceOwnerSoldToContact",
"InvoiceOwnerBillToAndSoldToContacts",
"InvoiceOwnerAllContacts"
],
"type": "string",
"default": "SpecificEmails",
"description": "Email cc type."
},
"description": {
"type": "string",
"maxLength": 255,
"description": "The description of the email template."
},
"toEmailType": {
"enum": [
"BillToContact",
"SoldToContact",
"SpecificEmails",
"TenantAdmin",
"BillToAndSoldToContacts",
"RunOwner",
"AllContacts",
"InvoiceOwnerBillToContact",
"InvoiceOwnerSoldToContact",
"InvoiceOwnerBillToAndSoldToContacts",
"InvoiceOwnerAllContacts"
],
"type": "string",
"description": "Email receive type."
},
"emailHeaders": {
"type": "object",
"title": "emailHeader",
"description": "Container for custom email headers. Each custom email header consists of a header name and a header value.\n",
"additionalProperties": {
"type": "string",
"description": "The custom email header consists of a name-value pair:\n\n* Field name: the name of the custom email header.\n\n* Field value: the value of the custom email header. You can add merge fields in the field value. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates\" target=\"_blank\">Merge field syntax for email templates</a>.\n"
}
},
"emailSubject": {
"type": "string",
"description": "The email subject. You can add merge fields in the email subject using angle brackets or double curly brackets. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates\" target=\"_blank\">Merge field syntax for email templates</a>.\n"
},
"encodingType": {
"enum": [
"UTF8",
"Shift_JIS",
"ISO_2022_JP",
"EUC_JP",
"X_SJIS_0213"
],
"type": "string",
"description": "The endcode type of the email body."
},
"eventCategory": {
"type": "number",
"description": "The event category code for 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 event category codes."
},
"eventTypeName": {
"type": "string",
"minLength": 1,
"description": "The name of the custom event or custom scheduled event."
},
"fromEmailType": {
"enum": [
"TenantEmail",
"RunOwner",
"SpecificEmail"
],
"type": "string",
"description": "The from email type."
},
"ccEmailAddress": {
"type": "string",
"description": "Email CC address."
},
"toEmailAddress": {
"type": "string",
"description": "If `toEmailType` is `SpecificEmail`, this field is required."
},
"bccEmailAddress": {
"type": "string",
"format": "email",
"description": "Email BCC address."
},
"fromEmailAddress": {
"type": "string",
"description": "If formEmailType is SpecificEmail, this field is required."
},
"replyToEmailType": {
"enum": [
"TenantEmail",
"RunOwner",
"SpecificEmail"
],
"type": "string",
"description": "The reply email type."
},
"eventTypeNamespace": {
"type": "string",
"description": "The namespace of the `eventTypeName` field for custom events and custom scheduled events. \n"
},
"replyToEmailAddress": {
"type": "string",
"description": "If replyToEmailType is SpecificEmail, this field is required"
}
}
}
GETPublicNotificationDefinitionResponse
{
"type": "object",
"example": {
"id": "6e569e1e05f040eda51a927b140c0ac2X",
"name": "Account Edit Notification",
"active": true,
"callout": {
"id": "6e569e1e05f040eda51a927b140c0ac7",
"name": "Callout for Account Edited",
"active": true,
"httpMethod": "POST",
"calloutAuth": {
"domain": "example_domain",
"password": "example_password",
"username": "example_user",
"preemptive": true
},
"description": "Callout when an account is edited",
"calloutRetry": true,
"requiredAuth": true,
"calloutParams": {
"AccountName": "<Account.Name>",
"AccountNumber": "<Account.AccountNumber>"
},
"eventTypeName": "AccountEdit",
"calloutBaseurl": "https://www.example.com/callout/AccountEdit"
},
"createdBy": "6e569e1e05f040eda51a927b140c0ac3",
"createdOn": "2017-04-18T07:36:19.798Z",
"updatedBy": "6e569e1e05f040eda51a927b140c0ac4",
"updatedOn": "2017-04-18T07:36:19.798Z",
"filterRule": {
"id": "6e569e1e05f040eda51a927b140c0ac8",
"condition": "Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS",
"parameters": {
"_ACCOUNT_STATUS": {
"options": [
"Draft",
"Active",
"Canceled"
],
"valueType": "STRING",
"description": "The status of the VIP Account",
"displayName": "VIP Account Status"
},
"_VIP_BALANCE_AMOUNT": {
"options": null,
"valueType": "BIG_DECIMAL",
"description": "The minimum account balance",
"displayName": "VIP Account Balance"
}
},
"description": "Filter rule to test if an account is a VIP account",
"eventTypeName": null
},
"description": "Notification sent out when an account is edited",
"emailActive": true,
"calloutActive": true,
"eventTypeName": "AccountEdit",
"emailTemplateId": "6e569e1e05f040eda51a927b140c0ac6",
"filterRuleParams": {
"_ACCOUNT_STATUS": "Active",
"_VIP_BALANCE_AMOUNT": "100000"
},
"associatedAccount": "ParentAccount.Id",
"communicationProfileId": "6e569e1e05f040eda51a927b140c0ac5"
},
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID associated with this notification definition."
},
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the notification definition."
},
"active": {
"type": "boolean",
"description": "The status of the notification definition. The default value is `true`."
},
"callout": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID of the callout. If `calloutActive` is `true`, a callout is required. The eventTypeName of the callout MUST be the same as the eventTypeName."
},
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the created callout."
},
"active": {
"type": "boolean",
"default": true,
"description": "The status of the callout. The default value is `true`."
},
"httpMethod": {
"enum": [
"GET",
"PUT",
"POST",
"DELETE"
],
"type": "string",
"example": "POST",
"description": "The HTTP method of the callout."
},
"calloutAuth": {
"$ref": "#/components/schemas/CalloutAuth"
},
"description": {
"type": "string",
"maxLength": 255,
"description": "Description for the callout."
},
"calloutRetry": {
"type": "boolean",
"default": true,
"description": "Specified whether to retry the callout when the callout fails. The default value is `true`."
},
"requiredAuth": {
"type": "boolean",
"description": "Indicates whether Basic authentication is enabled for the callout."
},
"calloutParams": {
"$ref": "#/components/schemas/CalloutMergeFields"
},
"eventTypeName": {
"type": "string",
"minLength": 1,
"description": "The name of the custom event type."
},
"calloutBaseurl": {
"type": "string",
"format": "url",
"example": "https://***",
"minLength": 10,
"description": "The callout URL. It must start with 'https://'"
},
"requiredOauth2": {
"type": "boolean",
"description": "Indicates whether OAuth 2.0 authentication is enabled for the callout."
},
"oauth2ProviderId": {
"type": "string",
"description": "The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout."
}
}
},
"eventId": {
"type": "string",
"format": "uuid",
"description": "The ID of the event that the notification definition is based on.\n\nThis field is available only if the notification definition is based on a standard event. \n"
},
"createdBy": {
"type": "string",
"format": "uuid",
"description": "The ID of the user who created the notification definition."
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "The time when the notification definition was created. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00"
},
"updatedBy": {
"type": "string",
"format": "uuid",
"description": "The ID of the user who updated the notification definition."
},
"updatedOn": {
"type": "string",
"format": "date-time",
"description": "The time when the notification was updated. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00"
},
"filterRule": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID of the filter rule. If not specified or null, the notification definition is always qualified to process events of \"eventType\"."
},
"condition": {
"type": "string",
"example": "Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS",
"description": "The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/).\nThe rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to trigger an event when an invoice is posted with the amount over 1000, you would define the following condition on the `Invoice` object:\n\n```changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000```\n\nThere are conventions and keywords you need to be aware of. For example:\n\n* `changeType` is a keyword to specify what kind of change happened to the object. Allowed values are `INSERT`, `UPDATE` or `DELETE`.\n\n* `Invoice.Status` refers to field `Status` of the Zuora object `Invoice`.\n\n* A variable with the `_old` suffix means it’s a previous value of the corresponding object field. The \"_old\" fields are only available on the base objects.\n"
},
"parameters": {
"$ref": "#/components/schemas/FilterRuleParameterDefinitions"
},
"description": {
"type": "string",
"maxLength": 255,
"description": "The description of the filter rule."
},
"eventTypeName": {
"type": "string",
"minLength": 1,
"description": "The value is `null`."
}
},
"description": ""
},
"description": {
"type": "string",
"maxLength": 255,
"description": "Description of the notification definition"
},
"emailActive": {
"type": "boolean",
"description": "The status of the email action. The default value is `false`."
},
"calloutActive": {
"type": "boolean",
"description": "The status of the callout action. The default value is `false`."
},
"eventCategory": {
"type": "number",
"description": "The event category code for a standard event, on which the notification definition is created.\n\nThis field is available only if the notification definition is based on a standard event.\n\nFor the list of supported standard event category codes, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Events_and_Notifications\" target=\"_blank\">Standard event category code for events and notifications</a>.\n"
},
"eventTypeName": {
"type": "string",
"minLength": 1,
"description": "The name of the event that the notification definition is based on.\n\nThis field is available only if the notification definition is based on a Zuora custom event, custom event, or custom scheduled event.\n"
},
"emailTemplateId": {
"type": "string",
"format": "uuid",
"description": "The ID of the email template. In the request, there should be at least one email template or callout."
},
"filterRuleParams": {
"$ref": "#/components/schemas/FilterRuleParameterValues"
},
"associatedAccount": {
"type": "string",
"description": "The account on which the histories of this notification will be displayed. The associated account does not enforce where the merge fields come from.\n"
},
"eventTypeNamespace": {
"enum": [
"user.notification",
"com.zuora.notification"
],
"type": "string",
"description": "The namespace of the `eventTypeName` field. It indicates who created the event and which namespace the event is assigned to.\n\nSupported values are as follows:\n\n- `com.zuora.notification`: events that are created by Zuora. This value applies to Zuora custom events.\n- `user.notification`: events that are created by tenant users. This value applies to custom events and custom scheduled events.\n\nThis field is available only if the notification definition is based on a Zuora custom event, custom event, or custom scheduled event. \n"
},
"communicationProfileId": {
"type": "string",
"format": "uuid",
"description": "The profile that the notification definition belongs to."
}
}
}
GETRampByRampNumberResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"ramp": {
"$ref": "#/components/schemas/RampResponse"
}
}
},
{
"$ref": "#/components/schemas/CommonResponse"
}
]
}
GETRampMetricsByOrderNumberResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"rampMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderRampMetrics"
}
}
}
},
{
"$ref": "#/components/schemas/CommonResponse"
}
]
}
GETRampMetricsByRampNumberResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"rampMetrics": {
"$ref": "#/components/schemas/RampMetrics"
}
}
},
{
"$ref": "#/components/schemas/CommonResponse"
}
]
}
GETRampMetricsBySubscriptionKeyResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"rampMetrics": {
"$ref": "#/components/schemas/RampMetrics"
}
}
},
{
"$ref": "#/components/schemas/CommonResponse"
}
]
}
GETRampsBySubscriptionKeyResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"ramps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RampResponse"
}
}
}
},
{
"$ref": "#/components/schemas/CommonResponse"
}
]
}
GETRatePlanChargePricing
{
"type": "object",
"properties": {
"price": {
"type": "number",
"description": "The price. \n\nThis field is only applicable for charges based on the following charge models:\n - Flat Fee\n - Per Unit\n - Delivery Pricing\n"
},
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETRatePlanChargePricingTier"
},
"nullable": true,
"description": "Container for the tiers of the price item. \n\nThis field is only applicable for charges based on the following charge models:\n - Tiered Pricing\n - Volume Pricing\n - Tiered with Overage Pricing\n"
},
"currency": {
"type": "string",
"description": "The currency for the price.\n"
},
"overagePrice": {
"type": "number",
"nullable": true,
"description": "The overage price of the price item. \n\nThis field is only applicable for charges based on the Overage Pricing or Tiered with Overage Pricing charge model.\n"
},
"includedUnits": {
"type": "number",
"nullable": true,
"description": "The number of units included in this price item. \n\nThis field is only applicable for charges based on the Overage Pricing charge model.\n"
},
"discountAmount": {
"type": "number",
"format": "double",
"nullable": true,
"description": "The specific amount for a fixed discount. This field is applicable for charges based on the Discount-Fixed Amount charge model.\n"
},
"discountPercentage": {
"type": "number",
"format": "double",
"nullable": true,
"description": "The percentage of discount for a percentage discount. This field is applicable for charges based on the Discount-Percentage charge model.\n"
}
}
}
GETRatePlanChargePricingTier
{
"type": "array",
"items": {
"type": "object",
"properties": {
"price": {
"type": "number",
"format": "double",
"description": "The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.\n"
},
"currency": {
"type": "string",
"description": "The code corresponding to the currency for the price tier.\n"
},
"endingUnit": {
"type": "number",
"format": "double",
"description": "The end number of a range of units for the tier. This field is applicable for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model.\n"
},
"overagePrice": {
"type": "number",
"format": "double",
"description": "Indicates whether the price is an overage price, which is the price when usage surpasses the last defined tier.\n"
},
"startingUnit": {
"type": "number",
"format": "double",
"description": "The starting number of a range of units for the tier. This field is applicable for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model.\n"
},
"discountAmount": {
"type": "number",
"format": "double",
"description": "The specific amount for a fixed discount. This field is applicable for charges based on the Discount-Fixed Amount charge model.\n"
},
"discountPercentage": {
"type": "number",
"format": "double",
"description": "The percentage of discount for a percentage discount. This field is applicable for charges based on the Discount-Percentage charge model.\n"
}
}
},
"description": "Array of product rate plan charge tiers.\n\nYou should specify all relevant fields of all tiers, including pricing information for each currency.\n\nFor each currency, ensure that the tiers appear in ascending order of `StartingUnit`.\n\nFor example:\n\n```\n[\n {\n \"StartingUnit\": \"1\",\n \"EndingUnit\": \"150\",\n \"Currency\": \"USD\",\n \"Price\": 1.95,\n \"PriceFormat\": \"Per Unit\"\n },\n {\n \"StartingUnit\": \"151\",\n \"EndingUnit\": \"300\",\n \"Currency\": \"USD\",\n \"Price\": 1.45,\n \"PriceFormat\": \"Per Unit\"\n },\n {\n \"StartingUnit\": \"1\",\n \"EndingUnit\": \"150\",\n \"Currency\": \"EUR\",\n \"Price\": 1.75,\n \"PriceFormat\": \"Per Unit\"\n },\n {\n \"StartingUnit\": \"151\",\n \"EndingUnit\": \"300\",\n \"Currency\": \"EUR\",\n \"Price\": 1.30,\n \"PriceFormat\": \"Per Unit\"\n }\n]\n```\n"
}
GETRefundCollectionType
{
"type": "object",
"properties": {
"refunds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETRefundTypewithSuccess"
},
"description": "Container for refunds.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
}
}
GETRefundCreditMemoType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the created refund.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the refund.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the refund.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the refund.\n"
},
"status": {
"enum": [
"Processed",
"Canceled",
"Error",
"Processing"
],
"type": "string",
"description": "The status of the refund.\n"
},
"comment": {
"type": "string",
"description": "Comments about the refund.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the refund.\n"
},
"paymentId": {
"type": "string",
"description": "The ID of the payment associated with the refund.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways.\n"
},
"methodType": {
"enum": [
"ACH",
"Cash",
"Check",
"CreditCard",
"PayPal",
"WireTransfer",
"DebitCard",
"CreditCardReferenceTransaction",
"BankTransfer",
"Other"
],
"type": "string",
"description": "How an external refund was issued to a customer.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction.\n"
},
"refundDate": {
"type": "string",
"format": "date",
"description": "The date when the refund takes effect, in yyyy-mm-dd format.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the refund.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-06 15:31:10.\n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was submitted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the refund.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-07 15:36:10.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo that is refunded.\n"
},
"gatewayState": {
"enum": [
"MarkedForSubmission",
"Submitted",
"Settled",
"NotSubmitted",
"FailedToSettle"
],
"type": "string",
"description": "The status of the refund in the gateway.\n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the refund. This message is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the refund.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"bankAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to a bank account in your accounting system.\n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"description": "The accounting code for the unapplied payment.\n"
},
"unappliedPaymentAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the unapplied payment.\n"
}
},
"description": "Container for the finance information related to the refund.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The response code returned from the payment gateway for the refund. This code is gateway-dependent.\n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"refundTransactionTime": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.\n"
},
"secondRefundReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
}
}
},
{
"$ref": "#/components/schemas/RefundObjectNSFields"
},
{
"$ref": "#/components/schemas/RefundObjectCustomFields"
}
]
}
GETRefundItemPartCollectionType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"itemParts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETRefundItemPartTypewithSuccess"
},
"description": "Container for refund part items.\n"
}
}
}
GETRefundItemPartType
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the refund part item.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the refund part item.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the refund part item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund part item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the refund part item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund part item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"creditTaxItemId": {
"type": "string",
"description": "The ID of the credit memo taxation item associated with the refund part item.\n"
},
"creditMemoItemId": {
"type": "string",
"description": "The ID of the credit memo item associated with the refund part item.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
}
}
}
GETRefundItemPartTypewithSuccess
{
"type": "object",
"title": "itemParts",
"properties": {
"id": {
"type": "string",
"description": "The ID of the refund part item.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the refund part item.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the refund part item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund part item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the refund part item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund part item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"creditTaxItemId": {
"type": "string",
"description": "The ID of the credit memo taxation item associated with the refund part item.\n"
},
"creditMemoItemId": {
"type": "string",
"description": "The ID of the credit memo item associated with the refund part item.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
}
}
}
GETRefundPartCollectionType
{
"type": "object",
"properties": {
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RefundPartResponseTypewithSuccess"
},
"description": "Container for refund parts.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
}
}
}
GETRefundPaymentType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the created refund.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the refund.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the refund.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the refund.\n"
},
"status": {
"enum": [
"Processed",
"Canceled",
"Error",
"Processing"
],
"type": "string",
"description": "The status of the refund.\n"
},
"comment": {
"type": "string",
"description": "Comments about the refund.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"payoutId": {
"type": "string",
"description": "The payout ID of the refund from the gateway side.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the refund.\n"
},
"paymentId": {
"type": "string",
"description": "The ID of the payment that is refunded.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways.\n"
},
"methodType": {
"enum": [
"ACH",
"Cash",
"Check",
"CreditCard",
"PayPal",
"WireTransfer",
"DebitCard",
"CreditCardReferenceTransaction",
"BankTransfer",
"Other"
],
"type": "string",
"description": "How an external refund was issued to a customer.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. \n"
},
"refundDate": {
"type": "string",
"format": "date",
"description": "The date when the refund takes effect, in `yyyy-mm-dd` format.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format. \n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the refund.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. \n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was submitted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the the Zuora user who last updated the refund.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo associated with the refund.\n"
},
"gatewayState": {
"enum": [
"MarkedForSubmission",
"Submitted",
"Settled",
"NotSubmitted",
"FailedToSettle"
],
"type": "string",
"description": "The status of the refund in the gateway.\n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the refund. This message is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the refund. \n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"bankAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to a bank account in your accounting system.\n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"description": "The accounting code for the unapplied payment.\n"
},
"unappliedPaymentAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the unapplied payment.\n"
}
},
"description": "Container for the finance information related to the refund.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the refund. This code is gateway-dependent.\n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"paymentGatewayNumber": {
"type": "string",
"description": "The natural key for the payment gateway.\n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"refundTransactionTime": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.\n"
},
"secondRefundReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
},
{
"$ref": "#/components/schemas/RefundObjectNSFields"
},
{
"$ref": "#/components/schemas/RefundObjectCustomFields"
}
]
}
GETRefundPaymentTypeAutoUnapply
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the created refund.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the refund.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the refund.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the refund.\n"
},
"status": {
"enum": [
"Processed",
"Canceled",
"Error",
"Processing"
],
"type": "string",
"description": "The status of the refund.\n"
},
"comment": {
"type": "string",
"description": "Comments about the refund.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"payoutId": {
"type": "string",
"description": "The payout ID of the refund from the gateway side.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the refund.\n"
},
"paymentId": {
"type": "string",
"description": "The ID of the payment that is refunded.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways.\n"
},
"methodType": {
"enum": [
"ACH",
"Cash",
"Check",
"CreditCard",
"PayPal",
"WireTransfer",
"DebitCard",
"CreditCardReferenceTransaction",
"BankTransfer",
"Other"
],
"type": "string",
"description": "How an external refund was issued to a customer.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. \n"
},
"refundDate": {
"type": "string",
"format": "date",
"description": "The date when the refund takes effect, in `yyyy-mm-dd` format.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format. \n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the refund.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. \n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was submitted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the the Zuora user who last updated the refund.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo associated with the refund.\n"
},
"gatewayState": {
"enum": [
"MarkedForSubmission",
"Submitted",
"Settled",
"NotSubmitted",
"FailedToSettle"
],
"type": "string",
"description": "The status of the refund in the gateway.\n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the refund. This message is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the refund. \n"
},
"writeOffResults": {
"type": "object",
"properties": {
"errorMessage": {
"type": "string",
"description": "The error message about write off failed.\n"
},
"transactions": {
"type": "object",
"title": "transactions",
"properties": {
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The credit memo applied amopunt.\n"
},
"invoiceNumber": {
"type": "string",
"description": "The unique identification number of the invoice.\n"
},
"creditMemoAmount": {
"type": "string",
"description": "The credit memo amount.\n"
},
"creditMemoNumber": {
"type": "string",
"description": "The unique identification number of the credit memo.\n"
},
"creditMemoStatus": {
"enum": [
"Draft",
"Posted",
"Canceled",
"Error",
"PendingForTax",
"Generating",
"CancelInProgress"
],
"type": "string",
"description": "The status of the credit memo. \n"
}
},
"description": "The credit memo apply information.\n"
}
},
"description": "Container for the write-off information of credit memo and apply information.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"bankAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to a bank account in your accounting system.\n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"description": "The accounting code for the unapplied payment.\n"
},
"unappliedPaymentAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the unapplied payment.\n"
}
},
"description": "Container for the finance information related to the refund.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the refund. This code is gateway-dependent.\n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"paymentGatewayNumber": {
"type": "string",
"description": "The natural key for the payment gateway.\n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"refundTransactionTime": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.\n"
},
"secondRefundReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
},
{
"$ref": "#/components/schemas/RefundObjectNSFields"
},
{
"$ref": "#/components/schemas/RefundObjectCustomFields"
}
]
}
GETRefundType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the refund.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the refund. \n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the refund.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the refund.\n"
},
"status": {
"enum": [
"Processed",
"Canceled",
"Error",
"Processing"
],
"type": "string",
"description": "The status of the refund. \n"
},
"comment": {
"type": "string",
"description": "Comments about the refund.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"payoutId": {
"type": "string",
"description": "The payout ID of the refund from the gateway side.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment or credit memo.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the refund.\n"
},
"paymentId": {
"type": "string",
"description": "The ID of the payment that is refunded.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways.\n"
},
"methodType": {
"enum": [
"ACH",
"Cash",
"Check",
"CreditCard",
"PayPal",
"WireTransfer",
"DebitCard",
"CreditCardReferenceTransaction",
"BankTransfer",
"Other"
],
"type": "string",
"description": "How an external refund was issued to a customer. \n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction.\n"
},
"refundDate": {
"type": "string",
"format": "date",
"description": "The date when the refund takes effect, in `yyyy-mm-dd` format. For example, `2017-03-01`.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the refund.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was created, in `yyyy-mm-dd hh:mm:ss` format. For example, `2017-03-01 15:31:10`.\n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was submitted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the refund.\n"
},
"updatedDate": {
"type": "string",
"example": "2017-03-02 15:36:10",
"description": "The date and time when the refund was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo that is refunded.\n"
},
"gatewayState": {
"enum": [
"MarkedForSubmission",
"Submitted",
"Settled",
"NotSubmitted",
"FailedToSettle"
],
"type": "string",
"description": "The status of the refund in the gateway.\n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the refund. This message is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the refund.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"bankAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to a bank account in your accounting system.\n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"description": "The accounting code for the unapplied payment.\n"
},
"unappliedPaymentAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the unapplied payment.\n"
}
},
"description": "Container for the finance information related to the refund.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the refund. This code is gateway-dependent.\n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways.\n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format. \n"
},
"refundTransactionTime": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.\n"
},
"secondRefundReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
},
{
"$ref": "#/components/schemas/RefundObjectNSFields"
},
{
"$ref": "#/components/schemas/RefundObjectCustomFields"
}
]
}
GETRefundTypewithSuccess
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the refund.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the refund. \n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the refund.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the refund.\n"
},
"status": {
"enum": [
"Processed",
"Canceled",
"Error",
"Processing"
],
"type": "string",
"description": "The status of the refund. \n"
},
"comment": {
"type": "string",
"description": "Comments about the refund.\n"
},
"payoutId": {
"type": "string",
"description": "The payout ID of the refund from the gateway side.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment or credit memo.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the refund.\n"
},
"paymentId": {
"type": "string",
"description": "The ID of the payment that is refunded.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways.\n"
},
"methodType": {
"enum": [
"ACH",
"Cash",
"Check",
"CreditCard",
"PayPal",
"WireTransfer",
"DebitCard",
"CreditCardReferenceTransaction",
"BankTransfer",
"Other"
],
"type": "string",
"description": "How an external refund was issued to a customer. \n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction.\n"
},
"refundDate": {
"type": "string",
"format": "date",
"description": "The date when the refund takes effect, in `yyyy-mm-dd` format. For example, 2017-03-01.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the refund.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was submitted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the refund.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo that is refunded.\n"
},
"gatewayState": {
"enum": [
"MarkedForSubmission",
"Submitted",
"Settled",
"NotSubmitted",
"FailedToSettle"
],
"type": "string",
"description": "The status of the refund in the gateway. \n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the refund. This message is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the refund.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"bankAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to a bank account in your accounting system.\n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"description": "The accounting code for the unapplied payment.\n"
},
"unappliedPaymentAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the unapplied payment.\n"
}
},
"description": "Container for the finance information related to the refund.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the refund. This code is gateway-dependent.\n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways.\n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"refundTransactionTime": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.\n"
},
"secondRefundReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
},
{
"$ref": "#/components/schemas/RefundObjectNSFields"
},
{
"$ref": "#/components/schemas/RefundObjectCustomFields"
}
],
"title": "refunds"
}
GETSequenceSetResponse
{
"type": "object",
"title": "sequenceSets",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the sequence set. For example, 402892c74c9193cd014c96bbe7c101f9.\n"
},
"name": {
"type": "string",
"description": "The name of the sequence set.\n"
},
"refund": {
"$ref": "#/components/schemas/RefundEntityPrefix"
},
"invoice": {
"$ref": "#/components/schemas/InvoiceEntityPrefix"
},
"payment": {
"$ref": "#/components/schemas/PaymentEntityPrefix"
},
"debitMemo": {
"$ref": "#/components/schemas/DebitMemoEntityPrefix"
},
"creditMemo": {
"$ref": "#/components/schemas/CreditMemoEntityPrefix"
}
},
"description": ""
}
GETSequenceSetsResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded.\n"
},
"sequenceSets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETSequenceSetResponse"
},
"description": "Array of sequence sets configured for billing documents, payments, and refunds.\n"
}
},
"description": ""
}
GETSubscriptionProductFeatureType
{
"type": "object",
"title": "subscriptionProductFeatures",
"properties": {
"id": {
"type": "string",
"description": "SubscriptionProductFeature ID.\n"
},
"name": {
"type": "string",
"description": "Feature name, up to 255 characters long.\n"
},
"description": {
"type": "string",
"description": "Feature description.\n"
},
"featureCode": {
"type": "string",
"description": "Feature code, up to 255 characters long.\n"
}
}
}
GETSubscriptionRatePlanChargesType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Rate plan charge ID.\n"
},
"mrr": {
"type": "number",
"description": "Monthly recurring revenue of the rate plan charge.\n"
},
"tcv": {
"type": "number",
"description": "The total contract value.\n"
},
"uom": {
"type": "string",
"description": "Specifies the units to measure usage. \n"
},
"dmrc": {
"type": "number",
"description": "The change (delta) of monthly recurring charge exists when the change in monthly recurring revenue caused by an amendment or a new subscription.\n"
},
"done": {
"type": "boolean",
"description": "A value of `true` indicates that an invoice for a charge segment has been completed. A value of `false` indicates that an invoice has not been completed for the charge segment.\n"
},
"dtcv": {
"type": "number",
"description": "After an amendment or an AutomatedPriceChange event, `dtcv` displays the change (delta) for the total contract value (TCV) amount for this charge, compared with its previous value with recurring charge types.\n"
},
"name": {
"type": "string",
"description": "Charge name.\n"
},
"type": {
"type": "string",
"description": "Charge type. Possible values are: `OneTime`, `Recurring`, `Usage`.\n"
},
"model": {
"type": "string",
"description": "Charge model; possible values are:\n\n* `FlatFee`\n* `PerUnit`\n* `Overage`\n* `Volume`\n* `Tiered`\n* `TieredWithOverage`\n* `DiscountFixedAmount`\n* `DiscountPercentage`\n* `MultiAttributePricing`\n* `PreratedPerUnit`\n* `PreratedPricing`\n* `HighWatermarkVolumePricing`\n* `HighWatermarkTieredPricing`\n* `Delivery`\n"
},
"price": {
"type": "number",
"description": "The price associated with the rate plan charge expressed as a decimal.\n"
},
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETTierType"
},
"description": "One or many defined ranges with distinct pricing.\n"
},
"number": {
"type": "string",
"description": "Charge number.\n"
},
"segment": {
"type": "integer",
"format": "int64",
"description": "The identifying number of the subscription rate plan segment. Segments are numbered sequentially, starting with 1.\n"
},
"version": {
"type": "integer",
"format": "int64",
"description": "Rate plan charge revision number.\n"
},
"currency": {
"type": "string",
"description": "Currency used by the account. For example, `USD` or `EUR`.\n"
},
"quantity": {
"type": "number",
"description": "The quantity of units, such as the number of authors in a hosted wiki service. Valid for all charge models except for Flat Fee pricing.\n"
},
"isPrepaid": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nIndicates whether this charge is a prepayment (topup) charge or a drawdown charge. Values: `true` or `false`.\n"
},
"billingDay": {
"type": "string",
"description": "Billing cycle day (BCD), which is when bill runs generate invoices\nfor charges associated with the product rate plan charge or the account. \n\nValues:\n\n* `DefaultFromCustomer`\n* `SpecificDayofMonth(# of the month)`\n* `SubscriptionStartDay`\n* `ChargeTriggerDay`\n* `SpecificDayofWeek/dayofweek`: in which dayofweek is the day in the week you define your billing periods to start.\n\nIn the response data, a day-of-the-month ordinal value (`first`-`31st`) appears in place of the hash sign above (\"#\"). If this value exceeds the number of days in a particular month, the last day of the month is used as the BCD.\n"
},
"isRollover": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe value is either \"True\" or \"False\". It determines whether the rollover fields are needed.\n"
},
"isUnbilled": {
"type": "boolean",
"description": "This field is used to dictate how to perform the accounting during revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"prepaidUom": {
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nUnit of measurement for a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"description": {
"type": "string",
"description": "Description of the rate plan charge.\n"
},
"drawdownUom": {
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nUnit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).\n"
},
"productLine": {
"type": "string",
"description": "This is used to maintain the product line. \n\n**Note**: This field is only available if you have the Additional Revenue Fields property enabled.\n"
},
"ratingGroup": {
"type": "string",
"description": "Specifies a rating group based on which usage records are rated.\n\nPossible values:\n\n- `ByBillingPeriod` (default): The rating is based on all the usages in a billing period.\n- `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. \n- `ByUsageRecord`: The rating is based on each usage record.\n- `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`).\n- `ByGroupId`: The rating is based on all the usages in a custom group.\n\n**Note:** \n- The `ByBillingPeriod` value can be applied for all charge models. \n- The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. \n- The `ByGroupId` value is only available if you have the Active Rating feature enabled.\n- Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`.\n"
},
"triggerDate": {
"type": "string",
"format": "date",
"description": "The date that the rate plan charge will be triggered.\n"
},
"upToPeriods": {
"type": "string",
"description": "Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.\n\nIf the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.\n"
},
"creditOption": {
"enum": [
"TimeBased",
"ConsumptionBased",
"FullCreditBack"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. \nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. \nThe way to calculate credit. See [Credit Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option) for more information.\n"
},
"drawdownRate": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).\n"
},
"overagePrice": {
"type": "number",
"description": "The price for units over the allowed amount.\n"
},
"productClass": {
"type": "string",
"description": "This is used to maintain the product class. \n\n**Note**: This field is only available if you have the Additional Revenue Fields property enabled. \n"
},
"triggerEvent": {
"type": "string",
"description": "The event that will cause the rate plan charge to be triggered.\n\nPossible values: \n\n* `ContractEffective`\n* `ServiceActivation`\n* `CustomerAcceptance`\n* `SpecificDate`\n"
},
"billingPeriod": {
"type": "string",
"description": "Allows billing period to be overridden on the rate plan charge.\n"
},
"billingTiming": {
"type": "string",
"description": "The billing timing for the charge. This field is only used if the `ratePlanChargeType` value is `Recurring`.\n\nPossible values are:\n\n* `In Advance`\n* `In Arrears`\n\n**Note:** 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"
},
"discountClass": {
"type": "string",
"description": "The class that the discount belongs to. The discount class defines the order in which discount rate plan charges are applied.\n\nFor more information, see [Manage Discount Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).\n"
},
"discountLevel": {
"type": "string",
"description": "The level of the discount. Values: `RatePlan`, `Subscription`, `Account`.\n"
},
"includedUnits": {
"type": "number",
"description": "Specifies the number of units in the base set of units.\n"
},
"listPriceBase": {
"type": "string",
"description": "List price base; possible values are:\n\n* `Per_Billing_Period`\n* `Per_Month`\n* `Per_Week`\n* `Per_Year`\n* `Per_Specific_Months`\n"
},
"productFamily": {
"type": "string",
"description": "This is used to maintain the product family. \n\n**Note**: This field is only available if you have the Additional Revenue Fields property enabled.\n"
},
"rolloverApply": {
"enum": [
"ApplyFirst",
"ApplyLast"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the priority of rollover, which is either first or last.\n"
},
"chargeFunction": {
"enum": [
"Standard",
"Prepayment",
"CommitmentTrueUp",
"Drawdown",
"CreditCommitment",
"DrawdownAndCreditCommitment"
],
"type": "string",
"description": "**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage\" target=\"_blank\">Unbilled Usage</a> feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to `141` or higher. Otherwise, an error occurs.\n\nThis field defines what type of charge it is in Advanced Consumption Billing:\n* Standard: Normal charge with no Prepayment or Commitment or Drawdown.\n* Prepayment: For recurring charges. Unit or currency based prepaid charge.\n* CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge.\n* Drawdown: For usage charges. Drawdown from prepaid funds.\n* DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds.\n* CreditCommitment: For usage charges. Credit to minimum commitment funds.\n"
},
"commitmentType": {
"enum": [
"UNIT",
"CURRENCY"
],
"type": "string",
"description": "**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage\" target=\"_blank\">Unbilled Usage</a> feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to `133` or higher. Otherwise, an error occurs. \n\nThis field defines the type of commitment. A prepaid charge can be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can only be `CURRENCY` type. For topup(recurring or one-time) charges, this field indicates what type of funds are created. \n* If UNIT, it will create a fund with given prepaidUom.\n* If CURRENCY, it will create a fund with the currency amount calculated in list price.\n \nFor drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges.\n"
},
"discountAmount": {
"type": "number",
"description": "The amount of the discount.\n"
},
"pricingSummary": {
"type": "string",
"description": "Concise description of rate plan charge model.\n"
},
"smoothingModel": {
"type": "string",
"description": "Specifies when revenue recognition begins. When charge model is `Overage` or `TieredWithOverage`, `smoothingModel` will be one of the following values:\n\n* `ContractEffectiveDate`\n* `ServiceActivationDate`\n* `CustomerAcceptanceDate`\n"
},
"applyDiscountTo": {
"type": "string",
"description": "Specifies the type of charges a specific discount applies to. \n\nThis field is only used when applied to a discount charge model. If you are not using a discount charge model, the value is null.\n\nPossible values:\n\n* `RECURRING`\n* `USAGE`\n* `ONETIMERECURRING`\n* `ONETIMEUSAGE`\n* `RECURRINGUSAGE`\n* `ONETIMERECURRINGUSAGE`\n"
},
"numberOfPeriods": {
"type": "integer",
"format": "int64",
"description": "Specifies the number of periods to use when calculating charges in an overage smoothing charge model.\n"
},
"prepaidQuantity": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).\n"
},
"productCategory": {
"type": "string",
"description": "This is used to maintain the product category. \n\n**Note**: This field is only available if you have the Additional Revenue Fields property enabled.\n"
},
"rolloverPeriods": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the number of rollover periods, it is restricted to 3.\n"
},
"specificEndDate": {
"type": "string",
"format": "date",
"description": "The specific date on which the charge ends. If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date.\n"
},
"upToPeriodsType": {
"type": "string",
"description": "The period type used to define when the charge ends. \n\nValues:\n\n* `Billing_Periods`\n* `Days`\n* `Weeks`\n* `Months`\n* `Years`\n"
},
"amendedByOrderOn": {
"type": "string",
"description": "The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n"
},
"effectiveEndDate": {
"type": "string",
"format": "date",
"description": "The effective end date of the rate plan charge.\n"
},
"endDateCondition": {
"type": "string",
"description": "Defines when the charge ends after the charge trigger date.\n\nIf the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date.\n\nValues:\n\n* `Subscription_End`\n* `Fixed_Period`\n* `Specific_End_Date`\n* `One_Time`\n"
},
"originalChargeId": {
"type": "string",
"description": "The original ID of the rate plan charge.\n"
},
"invoiceScheduleId": {
"type": "string",
"description": "The ID of the invoice schedule associated with the rate plan charge on the subscription.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"isStackedDiscount": {
"type": "boolean",
"description": "**Note**: This field is only applicable to the Discount - Percentage charge model.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 130 or higher. Otherwise, an error occurs.\n\nThis field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:\n - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.\n - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.\n\nFor more information, see [Stacked discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).\n"
},
"originalOrderDate": {
"type": "string",
"format": "date",
"description": "The date when the rate plan charge is created through an order or amendment.\n\nThis field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n"
},
"priceChangeOption": {
"type": "string",
"description": "When the following is true:\n\n1. AutomatedPriceChange setting is on\n\n2. Charge type is not one-time\n\n3. Charge model is not discount percentage\n\nThen an automatic price change can have a value for when a termed subscription is renewed. \n\nValues (one of the following):\n\n* `NoChange` (default)\n* `SpecificPercentageValue`\n* `UseLatestProductCatalogPricing`\n"
},
"chargedThroughDate": {
"type": "string",
"format": "date",
"description": "The date through which a customer has been billed for the charge.\n"
},
"discountPercentage": {
"type": "number",
"description": "The amount of the discount as a percentage.\n"
},
"effectiveStartDate": {
"type": "string",
"format": "date",
"description": "The effective start date of the rate plan charge.\n"
},
"numberOfDeliveries": {
"type": "number",
"description": "Number of deliveries in the billing period for the charge segment.\n\nThe `numberOfDeliveries` is used for the Delivery Pricing charge model only. \n"
},
"validityPeriodType": {
"enum": [
"SUBSCRIPTION_TERM",
"ANNUAL",
"SEMI_ANNUAL",
"QUARTER",
"MONTH"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"discountApplyDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETDiscountApplyDetailsType"
},
"description": "Container for the application details about a discount rate plan charge. \n\nOnly discount rate plan charges have values in this field.\n"
},
"isAllocationEligible": {
"type": "boolean",
"description": "This field is used to identify if the charge segment is allocation eligible in revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"prepaidOperationType": {
"enum": [
"topup",
"drawdown"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe type of this charge. It is either a prepayment (topup) charge or a drawdown charge. \n"
},
"prepaidTotalQuantity": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"processedThroughDate": {
"type": "string",
"format": "date",
"description": "The date until when charges have been processed. When billing in arrears, such as usage, this field value is the the same as the `ChargedThroughDate` value. This date is the earliest date when a charge can be amended.\n"
},
"rolloverPeriodLength": {
"type": "integer",
"default": null,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period length of the rollover fund.\n"
},
"specificBillingPeriod": {
"type": "integer",
"format": "int64",
"description": "Customizes the number of month or week for the charges billing period. This field is required if you set the value of the `BillingPeriod` field to `Specific_Months` or `Specific_Weeks`.\n"
},
"specificListPriceBase": {
"description": "The number of months for the list price base of the charge. \n\n**Note**: \n - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.\n"
},
"billingPeriodAlignment": {
"type": "string",
"description": "Possible values:\n\n* `AlignToCharge`\n* `AlignToSubscriptionStart`\n* `AlignToTermStart`\n"
},
"unusedUnitsCreditRates": {
"type": "number",
"description": "Specifies the rate to credit a customer for unused units of usage. This field is applicable only for overage charge models when the \n`OverageUnusedUnitsCreditOption` field value is `CreditBySpecificRate`.\n"
},
"priceIncreasePercentage": {
"type": "number",
"description": "A planned future price increase amount as a percentage.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": ""
},
"usageRecordRatingOption": {
"type": "string",
"description": "Determines how Zuora processes usage records for per-unit usage charges. \n"
},
"chargeModelConfiguration": {
"$ref": "#/components/schemas/ChargeModelConfigurationType"
},
"overageCalculationOption": {
"type": "string",
"description": "Determines when to calculate overage charges.\n"
},
"revenueRecognitionTiming": {
"enum": [
"Upon Billing Document Posting Date",
"Upon Order Activation Date"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue recognition timing.\n\nPredefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"upsellOriginChargeNumber": {
"type": "string",
"description": "The identifier of the original upselling charge associated with the current charge.\n\nFor a termed subscription, you can now use the \"Create an order\" API operation to perform an Add Product order action to make a product quantity upsell for per unit recurring charges. The benefit is that the charge added by this approach will be automatically combined with the original existing charge for which you want to upsell when the subscription is renewed. The approach is as follows:\n* Use an Add Product order action to add a charge that is of the same charge type, charge model, and charge end date as the existing per unit recurring charge for which you want to make a quantity upsell.\n\n* In the preceding charge to add, use the `upsellOriginChargeNumber` field to specify the existing rate plan charge for which you want to make the quantity upsell.\n\nNote that a termed subscription with such upsell charges can not be changed to an evergreen subscription. \n\n**Note**: The Quantity Upsell 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. If you want to join this early adopter program, submit a request at [Zuora Global\nSupport](https://support.zuora.com). \n"
},
"revenueAmortizationMethod": {
"enum": [
"Immediate",
"Ratable Using Start And End Dates"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue amortization method.\n\nPredefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"applyToBillingPeriodPartially": {
"type": "boolean",
"description": "Allow the discount duration to be aligned with the billing period partially.\n\n**Note**: This field is only available if you have the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature enabled.\n"
},
"overageUnusedUnitsCreditOption": {
"type": "string",
"description": "Determines whether to credit the customer with unused units of usage.\n"
},
"subscriptionChargeIntervalPricing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETIntervalPriceType"
},
"description": "Interval Pricing information. This field is available if the Offers feature is enabled.\n"
},
"subscriptionChargeDeliverySchedule": {
"$ref": "#/components/schemas/GETDeliveryScheduleType"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude rate plan charges from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/RatePlanChargeObjectCustomFields"
}
],
"title": "ratePlanCharges"
}
GETSubscriptionRatePlanType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Rate plan ID.\n"
},
"productId": {
"type": "string",
"description": ""
},
"productSku": {
"type": "string",
"description": "The unique SKU for the product.\n"
},
"productName": {
"type": "string",
"description": ""
},
"ratePlanName": {
"type": "string",
"description": "Name of the rate plan.\n"
},
"lastChangeType": {
"type": "string",
"description": "The last amendment on the rate plan. \n\n\n**Note:** If a subscription is created through an order, this field is only available if multiple orders are created on the subscription.\n\n\nPossible Values:\n * `Add`\n * `Update`\n * `Remove`\n"
},
"ratePlanCharges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETSubscriptionRatePlanChargesType"
},
"description": "Container for one or more charges.\n"
},
"productRatePlanId": {
"type": "string",
"description": ""
},
"externallyManagedPlanId": {
"type": "string",
"description": "Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n"
},
"subscriptionProductFeatures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETSubscriptionProductFeatureType"
},
"description": "Container for one or more features. \n\nOnly available when the following settings are enabled:\n\n* The Entitlements feature in your tenant.\n\n* The Enable Feature Specification in Product and Subscriptions setting in Zuora Billing Settings"
}
}
},
{
"$ref": "#/components/schemas/RatePlanObjectCustomFields"
}
],
"title": "ratePlans"
}
GETSubscriptionStatusHistoryType
{
"allOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the subscription.\n\nValues are:\n\n* `Pending Activation`\n* `Pending Acceptance`\n* `Active`\n* `Cancelled`\n* `Suspended`\n* `OutOfTerm`\n"
},
"endDate": {
"type": "string",
"format": "date",
"description": "The effective end date of the status history."
},
"startDate": {
"type": "string",
"format": "date",
"description": "The effective start date of the status history."
}
}
}
],
"title": "statusHistory"
}
GETSubscriptionType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Subscription ID.\n"
},
"notes": {
"type": "string",
"description": "A string of up to 65,535 characters.\n"
},
"status": {
"type": "string",
"description": "Subscription status; possible values are:\n\n* `Draft`\n* `Pending Activation`\n* `Pending Acceptance`\n* `Active`\n* `Cancelled`\n* `Suspended`\n"
},
"version": {
"type": "integer",
"format": "int64",
"description": "This is the subscription version automatically generated by Zuora Billing. Each order or amendment creates a new version of the subscription, which incorporates the changes made in the order or amendment."
},
"currency": {
"type": "string",
"description": "The currency of the subscription.\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currencies</a> feature enabled.\n"
},
"revision": {
"type": "string",
"description": "An auto-generated decimal value uniquely tagged with a subscription. The value always contains one decimal place, for example, the revision of a new subscription is 1.0. If a further version of the subscription is created, the revision value will be increased by 1. Also, the revision value is always incremental regardless of deletion of subscription versions.\n"
},
"termType": {
"type": "string",
"description": "Possible values are: `TERMED`, `EVERGREEN`.\n"
},
"accountId": {
"type": "string",
"description": ""
},
"autoRenew": {
"type": "boolean",
"description": "If `true`, the subscription automatically renews at the end of the term. Default is `false`.\n"
},
"ratePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETSubscriptionRatePlanType"
},
"description": "Container for rate plans.\n"
},
"accountName": {
"type": "string",
"description": ""
},
"currentTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the current subscription term.\n"
},
"initialTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the first subscription term.\n"
},
"orderNumber": {
"type": "string",
"description": "The order number of the order in which the changes on the subscription are made. \n\n**Note:** This field is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). We will investigate your use cases and data before enabling this feature for you.\n"
},
"paymentTerm": {
"type": "string",
"description": "The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"renewalTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the subscription renewal term.\n"
},
"termEndDate": {
"type": "string",
"format": "date",
"description": "Date the subscription term ends. If the subscription is evergreen, this is null or is the cancellation date (if one has been set).\n"
},
"cancelReason": {
"type": "string",
"description": "The reason for a subscription cancellation copied from the `changeReason` field of a Cancel Subscription order action. \n\nThis field contains valid value only if a subscription is cancelled through the Orders UI or API. Otherwise, the value for this field will always be `null`.\n"
},
"accountNumber": {
"type": "string",
"description": ""
},
"billToContact": {
"$ref": "#/components/schemas/GETAccountSummaryTypeBillToContact"
},
"contractedMrr": {
"type": "number",
"description": "Monthly recurring revenue of the subscription.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"soldToContact": {
"$ref": "#/components/schemas/GETAccountSummaryTypeSoldToContact"
},
"statusHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETSubscriptionStatusHistoryType"
},
"description": "Container for status history.\n"
},
"termStartDate": {
"type": "string",
"format": "date",
"description": "Date the subscription term begins. If this is a renewal subscription, this date is different from the subscription start date.\n"
},
"renewalSetting": {
"type": "string",
"description": "Specifies whether a termed subscription will remain `TERMED` or change to `EVERGREEN` when it is renewed. \n\nValues are:\n\n* `RENEW_WITH_SPECIFIC_TERM` (default)\n* `RENEW_TO_EVERGREEN`\n"
},
"isLatestVersion": {
"type": "boolean",
"description": "If `true`, the current subscription object is the latest version."
},
"lastBookingDate": {
"type": "string",
"format": "date",
"description": "The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value `today` is set per the user's timezone. The value of this field is as follows:\n* For a new subscription created by the [Subscribe and Amend APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate), this field has the value of the subscription creation date.\n* For a subscription changed by an amendment, this field has the value of the amendment booking date.\n* For a subscription created or changed by an order, this field has the value of the order date. "
},
"sequenceSetName": {
"type": "string",
"description": "The name of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `sequenceSetId` field in the request or you select **Default Template from Account** for the `sequenceSetId` field during subscription creation, the value of the `sequenceSetName` field is automatically set to `null` in the response body.\n"
},
"invoiceScheduleId": {
"type": "integer",
"description": "The ID of the invoice schedule associated with the subscription.\n\nIf multiple invoice schedules are created for different terms of a subscription, this field stores the latest invoice schedule.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"invoiceSeparately": {
"type": "string",
"description": "Separates a single subscription from other subscriptions and creates an invoice for the subscription. \n\nIf the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"description": "The number of the invoice group associated with the subscription.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"subscriptionNumber": {
"type": "string",
"description": ""
},
"externallyManagedBy": {
"enum": [
"Amazon",
"Apple",
"Google",
"Roku"
],
"type": "string",
"description": "An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.\n"
},
"invoiceTemplateName": {
"type": "string",
"description": "The name of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `invoiceTemplateId` field in the request or you select **Default Template from Account** for the `invoiceTemplateId` field during subscription creation, the value of the `invoiceTemplateName` field is automatically set to `null` in the response body.\n \n"
},
"subscriptionEndDate": {
"type": "string",
"format": "date",
"description": "The date when the subscription term ends, where the subscription ends at midnight the day before.\nFor example, if the `subscriptionEndDate` is 12/31/2016, the subscriptions ends at midnight (00:00:00 hours) on 12/30/2016.\nThis date is the same as the term end date or the cancelation date, as appropriate.\n"
},
"totalContractedValue": {
"type": "number",
"description": "Total contracted value of the subscription.\n"
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "Effective contract date for this subscription, as yyyy-mm-dd.\n"
},
"currentTermPeriodType": {
"type": "string",
"description": "The period type for the current subscription term.\n\nValues are:\n\n* `Month` (default)\n* `Year`\n* `Day`\n* `Week`\n"
},
"initialTermPeriodType": {
"type": "string",
"description": "The period type for the first subscription term.\n\nValues are:\n\n* `Month` (default)\n* `Year`\n* `Day`\n* `Week`\n"
},
"invoiceOwnerAccountId": {
"type": "string",
"description": ""
},
"renewalTermPeriodType": {
"type": "string",
"description": "The period type for the subscription renewal term.\n\nValues are:\n\n* `Month` (default)\n* `Year`\n* `Day`\n* `Week`\n"
},
"serviceActivationDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd\n"
},
"subscriptionStartDate": {
"type": "string",
"format": "date",
"description": "Date the subscription becomes effective.\n"
},
"customerAcceptanceDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.\n"
},
"invoiceOwnerAccountName": {
"type": "string",
"description": ""
},
"invoiceOwnerAccountNumber": {
"type": "string",
"description": ""
}
}
},
{
"$ref": "#/components/schemas/SubscriptionObjectQTFields"
},
{
"$ref": "#/components/schemas/SubscriptionObjectNSFields"
},
{
"$ref": "#/components/schemas/SubscriptionObjectCustomFields"
}
],
"title": "subscriptions"
}
GETSubscriptionTypeWithSuccess
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Subscription ID.\n"
},
"notes": {
"type": "string",
"description": "A string of up to 65,535 characters.\n"
},
"status": {
"type": "string",
"description": "Subscription status; possible values are:\n\n* `Draft`\n* `Pending Activation`\n* `Pending Acceptance`\n* `Active`\n* `Cancelled`\n* `Suspended`\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"version": {
"type": "integer",
"format": "int64",
"description": "This is the subscription version automatically generated by Zuora Billing. Each order or amendment creates a new version of the subscription, which incorporates the changes made in the order or amendment."
},
"currency": {
"type": "string",
"description": "The currency of the subscription.\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currencies</a> feature enabled.\n"
},
"revision": {
"type": "string",
"description": "An auto-generated decimal value uniquely tagged with a subscription. The value always contains one decimal place, for example, the revision of a new subscription is 1.0. If a further version of the subscription is created, the revision value will be increased by 1. Also, the revision value is always incremental regardless of deletion of subscription versions.\n"
},
"termType": {
"type": "string",
"description": "Possible values are: `TERMED`, `EVERGREEN`.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with this subscription."
},
"autoRenew": {
"type": "boolean",
"description": "If `true`, the subscription automatically renews at the end of the term. Default is `false`.\n"
},
"ratePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETSubscriptionRatePlanType"
},
"description": "Container for rate plans.\n"
},
"accountName": {
"type": "string",
"description": "The name of the account associated with this subscription."
},
"currentTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the current subscription term.\n"
},
"initialTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the first subscription term.\n"
},
"orderNumber": {
"type": "string",
"description": "The order number of the order in which the changes on the subscription are made. \n\n**Note:** This field is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). We will investigate your use cases and data before enabling this feature for you.\n"
},
"paymentTerm": {
"type": "string",
"description": "The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"renewalTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the subscription renewal term.\n"
},
"termEndDate": {
"type": "string",
"format": "date",
"description": "Date the subscription term ends. If the subscription is evergreen, this is null or is the cancellation date (if one has been set).\n"
},
"cancelReason": {
"type": "string",
"description": "The reason for a subscription cancellation copied from the `changeReason` field of a Cancel Subscription order action. \n\nThis field contains valid value only if a subscription is cancelled through the Orders UI or API. Otherwise, the value for this field will always be `null`.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the account associated with this subscription."
},
"billToContact": {
"$ref": "#/components/schemas/GETAccountSummaryTypeBillToContact"
},
"contractedMrr": {
"type": "number",
"description": "Monthly recurring revenue of the subscription.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"soldToContact": {
"$ref": "#/components/schemas/GETAccountSummaryTypeSoldToContact"
},
"statusHistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETSubscriptionStatusHistoryType"
},
"description": "Container for status history.\n"
},
"termStartDate": {
"type": "string",
"format": "date",
"description": "Date the subscription term begins. If this is a renewal subscription, this date is different from the subscription start date.\n"
},
"renewalSetting": {
"type": "string",
"description": "Specifies whether a termed subscription will remain `TERMED` or change to `EVERGREEN` when it is renewed. \n\nValues are:\n\n* `RENEW_WITH_SPECIFIC_TERM` (default)\n* `RENEW_TO_EVERGREEN`\n"
},
"isLatestVersion": {
"type": "boolean",
"description": "If `true`, the current subscription object is the latest version."
},
"lastBookingDate": {
"type": "string",
"format": "date",
"description": "The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value `today` is set per the user's timezone. The value of this field is as follows:\n* For a new subscription created by the [Subscribe and Amend APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate), this field has the value of the subscription creation date.\n* For a subscription changed by an amendment, this field has the value of the amendment booking date.\n* For a subscription created or changed by an order, this field has the value of the order date. "
},
"sequenceSetName": {
"type": "string",
"description": "The name of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `sequenceSetId` field in the request or you select **Default Template from Account** for the `sequenceSetId` field during subscription creation, the value of the `sequenceSetName` field is automatically set to `null` in the response body.\n"
},
"invoiceScheduleId": {
"type": "integer",
"description": "The ID of the invoice schedule associated with the subscription.\n\nIf multiple invoice schedules are created for different terms of a subscription, this field stores the latest invoice schedule.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"invoiceSeparately": {
"type": "string",
"description": "Separates a single subscription from other subscriptions and creates an invoice for the subscription. \n\nIf the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"description": "The number of the invoice group associated with the subscription.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "Subscription number."
},
"externallyManagedBy": {
"enum": [
"Amazon",
"Apple",
"Google",
"Roku"
],
"type": "string",
"description": "An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.\n"
},
"invoiceTemplateName": {
"type": "string",
"description": "The name of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `invoiceTemplateId` field in the request or you select **Default Template from Account** for the `invoiceTemplateId` field during subscription creation, the value of the `invoiceTemplateName` field is automatically set to `null` in the response body.\n \n"
},
"subscriptionEndDate": {
"type": "string",
"format": "date",
"description": "The date when the subscription term ends, where the subscription ends at midnight the day before.\nFor example, if the `subscriptionEndDate` is 12/31/2016, the subscriptions ends at midnight (00:00:00 hours) on 12/30/2016.\nThis date is the same as the term end date or the cancelation date, as appropriate.\n"
},
"totalContractedValue": {
"type": "number",
"description": "Total contracted value of the subscription.\n"
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "Effective contract date for this subscription, as yyyy-mm-dd.\n"
},
"currentTermPeriodType": {
"type": "string",
"description": "The period type for the current subscription term.\n\nValues are:\n\n* `Month` (default)\n* `Year`\n* `Day`\n* `Week`\n"
},
"initialTermPeriodType": {
"type": "string",
"description": "The period type for the first subscription term.\n\nValues are:\n\n* `Month` (default)\n* `Year`\n* `Day`\n* `Week`\n"
},
"invoiceOwnerAccountId": {
"type": "string",
"description": ""
},
"renewalTermPeriodType": {
"type": "string",
"description": "The period type for the subscription renewal term.\n\nValues are:\n\n* `Month` (default)\n* `Year`\n* `Day`\n* `Week`\n"
},
"serviceActivationDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd\n"
},
"subscriptionStartDate": {
"type": "string",
"format": "date",
"description": "Date the subscription becomes effective.\n"
},
"customerAcceptanceDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.\n"
},
"invoiceOwnerAccountName": {
"type": "string",
"description": ""
},
"invoiceOwnerAccountNumber": {
"type": "string",
"description": ""
}
}
},
{
"$ref": "#/components/schemas/SubscriptionObjectQTFields"
},
{
"$ref": "#/components/schemas/SubscriptionObjectNSFields"
},
{
"$ref": "#/components/schemas/SubscriptionObjectCustomFields"
}
]
}
GETSubscriptionWrapper
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETSubscriptionType"
},
"description": "Array of subscriptions.\n"
}
}
}
GETTaxationItemListType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"taxationItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETTaxationItemTypewithSuccess"
},
"description": "Container for taxation items.\n"
}
}
}
GETTaxationItemType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the taxation item.\n"
},
"name": {
"type": "string",
"description": "The name of the taxation item.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific credit or debit memo.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date when the tax is applied to the credit or debit memo.\n"
},
"taxRate": {
"type": "number",
"format": "double",
"description": "The tax rate applied to the credit or debit memo.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of the tax applied to the credit or debit memo.\n"
},
"memoItemId": {
"type": "string",
"description": "The ID of the credit or debit memo associated with the taxation item.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the taxation item. \n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the taxation item was created in the Zuora system, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate applied to the credit or debit memo.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the taxation item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the taxation item was last updated, in `yyyy-mm-dd hh:mm:ss` format. \n"
},
"exemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field. \n"
},
"sourceTaxItemId": {
"type": "string",
"description": "The ID of the taxation item of the invoice, which the credit or debit memo is created from.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"onAccountAccountingCode": {
"type": "string",
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"onAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to an on account in your accounting system.\n"
},
"salesTaxPayableAccountingCode": {
"type": "string",
"description": "The accounting code for the sales taxes payable.\n"
},
"salesTaxPayableAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the sales taxes payable.\n"
}
},
"description": "Container for the finance information related to the taxation item.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
}
}
},
{
"$ref": "#/components/schemas/TaxationItemObjectCustomFields"
}
]
}
GETTaxationItemTypewithSuccess
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the taxation item.\n"
},
"name": {
"type": "string",
"description": "The name of the taxation item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific invoice.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date when the tax is applied to the invoice.\n"
},
"taxMode": {
"enum": [
"TaxInclusive",
"TaxExclusive"
],
"type": "string",
"description": "The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.\n"
},
"taxRate": {
"type": "number",
"format": "double",
"description": "The tax rate applied to the invoice.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of the tax applied to the invoice.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the taxation item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the taxation item was created in the Zuora system, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate applied to the invoice.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the taxation item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the taxation item was last updated, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"exemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field.\n"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the invoice associated with the taxation item.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"salesTaxPayableAccountingCode": {
"type": "string",
"description": "The accounting code for the sales taxes payable.\n"
},
"accountsReceivableAccountingCode": {
"type": "string",
"description": "The accounting code for accounts receivable.\n"
},
"salesTaxPayableAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the sales taxes payable.\n"
},
"accountsReceivableAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for accounts receivable.\n"
}
},
"description": "Container for the finance information related to the taxation item.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
}
}
},
{
"$ref": "#/components/schemas/TaxationItemObjectCustomFields"
}
],
"title": "taxationItems"
}
GETTaxationItemsOfCreditMemoItemType
{
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETCMTaxItemTypeNew"
},
"description": "Container for the taxation items of the credit memo item.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
}
}
]
}
GETTaxationItemsOfDebitMemoItemType
{
"allOf": [
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETDMTaxItemTypeNew"
},
"description": "Container for the taxation items of the debit memo item.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
}
}
]
}
GETTierType
{
"type": "object",
"title": "tiers",
"properties": {
"tier": {
"type": "integer",
"format": "int64",
"description": "Unique number of the tier.\n"
},
"price": {
"type": "number",
"description": "The decimal value of the tiered charge model. If the charge model is not a tiered type then this price field will be null and the `price` field directly under the `productRatePlanCharges` applies.\n"
},
"endingUnit": {
"type": "number",
"description": "Decimal defining end of tier range.\n"
},
"priceFormat": {
"type": "string",
"description": "Tier price format. Allowed values: `flat fee`, `per unit`.\n"
},
"startingUnit": {
"type": "number",
"description": "Decimal defining start of tier range.\n"
}
}
}
GETUsageRateDetailWrapper
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"uom": {
"type": "string",
"description": "The unit of measurement of the invoice item.\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "The quantity of the invoice item.\n\nCould be a negative amount. Negative quantity usage records are used to adjust the previously uploaded usage records.\n"
},
"invoiceId": {
"type": "string",
"description": "The unique ID of the invoice.\n"
},
"listPrice": {
"type": "string",
"description": "The list price of the product rate plan charge associated with the invoice item. For example, if the product rate plan charge uses the tiered charge model, its list price could be: \n\nTier / From / To / List Price / Price Format\\n1 / 0 / 9 / 0.00 / Per Unit\\n2 / 10 / 20 / 1.00 / Per Unit\\n3 / 21 / 30 / 2.00 / Flat Fee\\n4 / 31 / / 3.00 / Per Unit\\n\n"
},
"rateDetail": {
"type": "string",
"description": "The rate detail of the invoice item. It shows how the total amount is calculated. For example, if the product rate plan charge uses the tiered charge model, the rate detail for the associated invoice item could be: \n\nTier 1: 0-9, 9 Each(s) x $0.00/Each = $0.00\\nTier 2: 10-20, 11 Each(s) x $1.00/Each = $11.00\\nTier 3: 21-30, $2.00 Flat Fee\\nTier 4: >=31, 15 Each(s) x $3.00/Each = $45.00\\nTotal = $58.00. \n\nThe rate detail retrieved from this REST API operation 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"
},
"chargeNumber": {
"type": "string",
"description": "The unique number of the product rate plan charge associated with the invoice item.\n"
},
"invoiceItemId": {
"type": "string",
"description": "The unique ID of the invoice item.\n"
},
"invoiceNumber": {
"type": "string",
"description": "The unique number of the invoice.\n"
},
"servicePeriod": {
"type": "string",
"description": "The service period of the invoice item.\n"
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "The amount of the invoice item without tax.\n"
}
},
"description": "Contains usage rate details for the invoice item as specified in the request.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully. \n\n\nReturns `false` if the request was not processed successfully. \n"
}
}
}
GETUsageType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID for the usage item.\n"
},
"status": {
"type": "string",
"description": "Possible values are: `Importing`, `Pending`, `Processed`.\n"
},
"fileName": {
"type": "string",
"description": "The name of the import file when the usage record is imported from the file.\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "Number of units used. \n\nCould be a negative quantity. Negative quantity usage records are used to adjust the previously uploaded usage records.\n"
},
"accountId": {
"type": "string",
"description": "Customer account ID.\n"
},
"uniqueKey": {
"type": "string",
"description": "a customer-defined specific identifier of a usage record.\n\n**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. See [Upload usage record with unique key](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Prepaid_balance_transactions#Upload_usage_record_with_unique_key) for more information.\n"
},
"sourceName": {
"type": "string",
"description": "Source of the usage data. Possible values are: `Import`, `API`.\n"
},
"accountName": {
"type": "string",
"description": "Customer account name.\n"
},
"chargeNumber": {
"type": "string",
"description": "Number of the rate-plan charge that pays for this usage.\n"
},
"accountNumber": {
"type": "string",
"description": "Customer account number.\n"
},
"startDateTime": {
"type": "string",
"format": "date-time",
"description": "Start date of the time period in which usage is tracked. Zuora uses this field value to determine the usage date.\n"
},
"unitOfMeasure": {
"type": "string",
"description": "Unit used to measure consumption.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"submissionDateTime": {
"type": "string",
"format": "date-time",
"description": "Date when usage was submitted.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "Number of the subscription covering this usage.\n"
}
}
},
{
"$ref": "#/components/schemas/UsageObjectCustomFields"
}
],
"title": "usage"
}
GETUsageWrapper
{
"type": "object",
"properties": {
"usage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETUsageType"
},
"description": "Contains one or more usage items.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
}
}
GenerateBillingDocumentResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceResponseType"
},
"description": "Container for generated invoics.\n"
},
"creditMemos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoResponseType"
},
"description": "Container for generated credit memos.\n\n**Note:** This container 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
}
}
}
GetAccountEInvoiceProfile
{
"type": "object",
"title": "einvoiceProfile",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the e-invoicing profile for the customer account is enabled. \n\nIf the following conditions are met, all billing documents for one account can be submitted to an e-invoicing service provider to be generated in electronic format:\n- The account must be configured to generate e-invoice files for billing documents.\n- The billing document must be in Posted status.\n- A business region must be created for the billing country contact, and be linked to an e-invoicing service provider.\n"
},
"endpointId": {
"type": "string",
"description": "The Buyer's electronic address, to which the application-level response to the billing document might be delivered.\n"
},
"businessName": {
"type": "string",
"maxLength": 255,
"description": "The full official name that the Buyer is registered with the relevant legal authority.\n"
},
"businessNumber": {
"type": "string",
"description": "The unique identifier number of the legal entity or person that you do business with.\n\nFor example, you must use a GSTIN for India.\n"
},
"businessCategory": {
"enum": [
"B2B",
"B2C",
"B2G"
],
"type": "string",
"description": "The high-level category of the business.\n"
},
"endpointSchemeId": {
"type": "string",
"description": "The identification scheme identifier of the Buyer’s electronic address.\n"
},
"taxRegisterNumber": {
"type": "string",
"description": "The Buyer's VAT identifier (also known as the Buyer's VAT identification number) or the local identification (defined by the Buyer’s address) of the Buyer for tax purposes, or a reference that enables the Buyer to state the registered tax status.\n"
},
"businessNumberSchemeId": {
"type": "string",
"description": "The identification scheme identifier that an official registrar issues to identify the Buyer as a legal entity or person.\n"
}
},
"description": "Container for e-invoicing profile information for this account.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
}
GetAggregateQueryJobResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The job ID created for the AQuA API request. The job ID can be used for querying for the query status. \n\nThe ID exists only if the JSON request can be parsed and validated successfully. Otherwise, the job ID is null.\n"
},
"name": {
"type": "string",
"description": "The name of the job. 32 character limit.\n"
},
"format": {
"enum": [
"csv",
"zip",
"gzip"
],
"type": "string",
"description": "The format of the query. The default value is `csv`.\n"
},
"status": {
"enum": [
"submitted",
"executing",
"completed",
"error",
"aborted",
"cancelled"
],
"type": "string",
"description": "The status of the AQuA job:\n- submitted: The AQuA job was submitted to the query executor for processing.\n- executing: The AQuA job is being processed.\n- completed: The AQuA job was successfully executed.\n- error: The AQuA job was not processed because of validation errors.\n- aborted: The AQuA job execution failed because one or more queries of this job failed.\n- cancelled: The AQuA job was cancelled.\n"
},
"batches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchesQueriesById"
},
"required": [
"name",
"query",
"status",
"batchId",
"batchType"
],
"description": "A JSON array object that contains a list of batch objects.\n"
},
"partner": {
"type": "string",
"description": "The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days.\n\nIt must be used together with \"project\" field to uniquely identify a data integration target.\n\nFor example, if a continuous AQuA session is to retrieve data incrementally for a Salesforce.com Org 00170000011K3Ub, you can use partner as \"Salesforce\", and \"project\" as \"00170000011K3Ub.\" \n\nThis field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.\n\n**Note**: Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Bulk_data__extraction_from_Zuora_using_AQuA\" target=\"_blank\">Bulk data extraction from Zuora using AQuA</a> for best practices.\n\n**Note**: Submit a request at <a href=\"http://support.zuora.com\" target=\"_blank\">Zuora Global Support</a> to obtain a partner ID.\n"
},
"project": {
"type": "string",
"description": "The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days.\n\nThis field must be used together with partner field to uniquely identify a data integration target. \n\nThis field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.\n"
},
"version": {
"type": "number",
"format": "float",
"description": "The API version you want to use. \n\nThe supported versions are as follows:\n - `1.1`. It supports both modes\n - `1.0`. Default. It supports stateless modes only.\n\nSee <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/BA_Stateless_and_Stateful_Modes\" target=\"_blank\">Stateless and stateful modes</a> for more information.\n"
},
"encrypted": {
"enum": [
"pgp",
"none"
],
"type": "string",
"description": "If enabled, you must supply the formatting (zip or unzip) first and decrypt it to get the actual contents.\n"
},
"startTime": {
"type": "string",
"description": "The start time of the query. \n"
},
"sourceData": {
"type": "string",
"description": "Indicates the source this aggregate query runs against:\n\n* `LIVE` represents the live transactional databases at Zuora (Data Query Live).\n\n* `WAREHOUSE` represents Zuora Warehouse, which has better performance and fewer limitations than the live transactional database. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_Warehouse/A_Zuora_Warehouse_overview\" target=\"_blank\">Zuora Warehouse</a>.\n"
}
}
}
GetAllOrdersResponseType
{
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
},
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
}
}
GetApiVolumeSummaryResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVolumeSummaryRecord"
},
"description": "List of API volume summary records. The records are grouped and ordered by API path name and http method. \n"
}
}
}
GetBillRunResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unqie ID of the bill run.\n"
},
"name": {
"type": "string",
"description": "The name of the bill run.\n"
},
"status": {
"enum": [
"Pending",
"Processing",
"Completed",
"Error",
"Canceled",
"Posted",
"PostInProgress",
"CancelInProgress",
"RemoveInProgress",
"Paused"
],
"type": "string",
"description": "The status of the bill run.\n"
},
"batches": {
"type": "array",
"items": {
"type": "string"
},
"description": "The batch of accounts for this bill run, this field can not exist with `billRunFilters` together.\n\n**Values:** `AllBatches` or an array of `Batch`*n* where *n* is a number between 1 and 50, for example, `Batch7`.\n"
},
"autoPost": {
"type": "boolean",
"description": "Whether to automatically post the bill run after the bill run is created.\n"
},
"schedule": {
"$ref": "#/components/schemas/BillRunScheduleResponseType"
},
"autoEmail": {
"type": "boolean",
"description": "Whether to automatically send emails after Auto-Post is complete.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for this bill run, only valid for ad-hoc bill runs.\n"
},
"autoRenewal": {
"type": "boolean",
"description": "Whether to automatically renew auto-renew subscriptions that are up for renewal.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the user who created the bill run.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the bill run was created.\n"
},
"invoiceDate": {
"type": "string",
"format": "date",
"description": "The invoice date for this bill run, only valid for ad-hoc bill runs.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the user who last updated the bill run.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the bill run was last updated.\n"
},
"billCycleDay": {
"type": "string",
"description": "The day of the bill cycle, this field is only valid when `batches` is specified.\n\n**Values:** \n- `AllBillCycleDays` or one of numbers 1 - 31 for an ad-hoc bill run\n- `AllBillCycleDays`, one of numbers 1 - 31, or `AsRunDay` for a scheduled bill run\n"
},
"billRunNumber": {
"type": "string",
"description": "The number of the bill run.\n"
},
"billRunFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillRunFilterResponseType"
},
"description": "The target account or subscriptions for this bill run.\n"
},
"targetDateOffset": {
"type": "integer",
"description": "The offset compared to bill run execution date, only valid for scheduled bill runs.\n"
},
"invoiceDateOffset": {
"type": "integer",
"description": "The offset compared to bill run execution date, only valid for scheduled bill runs.\n"
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organization(s) that the run is created for. \n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"chargeTypeToExclude": {
"type": "array",
"items": {
"enum": [
"OneTime",
"Recurring",
"Usage"
],
"type": "string"
},
"description": "The types of the charges to be excluded from the generation of billing documents.\n"
},
"scheduledExecutionTime": {
"type": "string",
"format": "date-time",
"description": "The scheduled execution time for a bill run.\n"
},
"noEmailForZeroAmountInvoice": {
"type": "boolean",
"description": "Whether to suppress emails for invoices with zero total amount generated in this bill run after the bill run is complete. \n"
}
}
}
],
"example": {
"id": "2c9890077e8a8490017e8bf3a5171a43X",
"name": "test",
"status": "Pending",
"batches": null,
"success": true,
"autoPost": false,
"schedule": null,
"autoEmail": false,
"targetDate": "2020-02-01",
"autoRenewal": false,
"createdById": "ff808081298c6e5401298c7274a40005",
"createdDate": "2022-01-24 19:58:27",
"invoiceDate": "2020-02-01",
"updatedById": "ff808081298c6e5401298c7274a40005",
"updatedDate": "2022-01-24 19:58:27",
"billCycleDay": null,
"billRunNumber": "BR-00000016",
"billRunFilters": [
{
"accountId": "2c9081a03c63c94c013c66688a2c00bf",
"filterType": "Subscription",
"subscriptionId": "402882297e387c51017e38a245c313db"
}
],
"targetDateOffset": null,
"invoiceDateOffset": null,
"chargeTypeToExclude": [
"OneTime",
"Usage"
],
"scheduledExecutionTime": null,
"noEmailForZeroAmountInvoice": false
}
}
GetBillingDocVolumeSummaryResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingDocVolumeSummaryRecord"
},
"description": "List of billing documents summary, including total generated invoices and credit memos, also a total number of accounts that failed to process.\n"
}
}
}
GetBillingPreviewRunResponse
{
"type": "object",
"properties": {
"batch": {
"type": "string",
"description": "The customer batch included in the billing preview run. \n\n**Note**: This field is not available if you set the `zuora-version` request header to `314.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"status": {
"type": "string",
"description": "The status of the >billing preview run.\n\n**Possible values:** \n\n* 0: Pending\n* 1: Processing\n* 2: Completed\n* 3: Error\n* 4: Canceled\n"
},
"batches": {
"type": "string",
"description": "The customer batches included in the billing preview run. \n\n**Note**: This field is only available if you set the `zuora-version` request header to `314.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"endDate": {
"type": "string",
"format": "datetime",
"description": "The date and time when the billing preview run completes.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"runNumber": {
"type": "string",
"description": "The run number of the billing preview run.\n"
},
"startDate": {
"type": "string",
"format": "datetime",
"description": "The date and time when the billing preview run starts.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for the billing preview run. \n"
},
"createdById": {
"type": "string",
"description": "The ID of the user who created the billing preview run.\n"
},
"createdDate": {
"type": "string",
"format": "datetime",
"description": "The date and time when the billing preview run was created.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the user who last updated the billing preview run.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the billing preview run was last updated.\n"
},
"errorMessage": {
"type": "string",
"description": "The error message generated by a failed billing preview run.\n"
},
"assumeRenewal": {
"type": "string",
"description": ""
},
"resultFileUrl": {
"type": "string",
"description": "The URL of the zipped CSV result file generated by the billing preview run. This file contains the preview invoice item data and credit memo item data for the specified customers.\n\nIf the value of `storageOption` field is `Database`, the returned `resultFileUrl` field is null.\n\n**Note:** The credit memo item data is only available if you have Invoice Settlement feature 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"storageOption": {
"enum": [
"Csv",
"Database"
],
"type": "string",
"description": "The saving options. The default value is `Csv`. \n"
},
"totalAccounts": {
"type": "integer",
"format": "int32",
"description": "The total number of accounts in the billing preview run.\n"
},
"succeededAccounts": {
"type": "integer",
"description": "The number of accounts for which preview invoice item data and credit memo item data was successfully generated during the billing preview run.\n\n**Note:** The credit memo item data is only available if you have Invoice Settlement feature 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organization(s) that the object belongs to. \n\nNote: This field is available only when the Multi-Org feature is enabled. \n"
},
"chargeTypeToExclude": {
"type": "string",
"description": "The charge types excluded from the forecast run.\n"
},
"includingDraftItems": {
"type": "boolean",
"description": "Whether draft document items are included in the billing preview run. By default, draft document items are not included.\n"
},
"includingEvergreenSubscription": {
"type": "boolean",
"description": "Indicates if evergreen subscriptions are included in the billing preview run.\n"
}
},
"description": "get billingPreviewRun response"
}
GetBookingDateBackfillJobByIdResponse
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"job": {
"$ref": "#/components/schemas/GETBookingDateJobResponse"
}
}
}
]
}
GetCascadingPaymentMethodsConfigurationResponse
{
"type": "object",
"properties": {
"consent": {
"type": "boolean",
"description": "`true` indicates the consent from your customer to use the Cascading Payment Method feature was collected. `false` indicates the consent was not collected and the Cascading Payment Method feature is not enabled.\n"
},
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded.\n"
},
"priorities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"minimum": 1,
"description": "The order of the payment method in the priority list. For example, `1` indicates the payment method is the first one in the priority list, and `2` indicates it is the second.\n\nThe first payment method in the priority list is the default payment method of the customer account.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The ID of a payment method.\n"
}
}
},
"title": "priority",
"description": "Container for the priority configuration of payment methods. \n"
}
}
}
GetCreditMemoPdfStatusBatchResponse
{
"type": "object",
"title": "creditMemoFiles",
"example": {
"success": true,
"creditMemoFiles": [
{
"createdOn": "2024-01-01 11:35:56",
"updatedOn": "2024-01-01 11:35:56",
"creditMemoId": "402824aa8cc894d5018cc8a120576881",
"creditMemoNumber": "CM00000003",
"pdfGenerationStatus": "Pending"
},
{
"createdOn": "2024-01-02 10:14:13",
"updatedOn": "2024-01-02 10:14:13",
"creditMemoId": "407624ab8cd894d5018cc8a155636987",
"creditMemoNumber": "CM00000004",
"pdfGenerationStatus": "Generated"
}
]
},
"properties": {
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded.\n"
},
"creditMemoFiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetCreditMemoPdfStatusResponse"
},
"description": "Array of credit memo PDF statuses requested.\n"
}
},
"description": ""
}
GetCreditMemoPdfStatusResponse
{
"allOf": [
{
"type": "object",
"properties": {
"createdOn": {
"type": "string",
"description": "The time at which the request to generate the PDF was created.\n"
},
"updatedOn": {
"type": "string",
"description": "The time at which the request to generate the PDF was updated.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo whose pdf status is requested.\n"
},
"creditMemoNumber": {
"type": "string",
"description": "The credit memo number of the credit memo whose pdf status is requested.\n"
},
"pdfGenerationStatus": {
"enum": [
"None",
"Pending",
"Processing",
"Generated",
"Error",
"Obsolete",
"Archived"
],
"type": "string",
"description": "The generation status of the credit memo PDF.\n"
}
}
}
]
}
GetDataBackfillJobByIdResponse
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"job": {
"$ref": "#/components/schemas/DataBackfillJob"
}
}
}
]
}
GetDataBackfillTemplateResponse
{
"type": "string"
}
GetDataLabelingJobResponse
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"format": "uuid",
"maxLength": 32,
"minLength": 32,
"description": "Identifier of the data labeling job.\n"
},
"success": {
"type": "boolean",
"description": "Indicates whether the job was submitted successfully.\n"
},
"progress": {
"type": "object",
"properties": {
"failed": {
"type": "integer",
"description": "The number of objects that have failed to be labeled.\n"
},
"labeled": {
"type": "integer",
"description": "The number of objects that have been labeled.\n"
},
"timeout": {
"type": "integer",
"description": "The number of objects that have timed out to be labeled. \n"
}
}
},
"jobStatus": {
"enum": [
"Accepted",
"Dispatched",
"Completed"
],
"type": "string",
"description": "Status of the data labeling job.\n\n* `Accepted` - The data labeling job has been accepted by the system.\n* `Dispatched` - The data labeling job is dispatched to the data labeling service.\n* `Completed` - The data labeling job has completed. Please note that `Completed` simply means the data labeling job has completed, but it does not mean the data labeling job has labeled all the data. You can check the `progress` field to see how many data have been `labeled`, `failed` or `timeout`.\n"
},
"objectType": {
"type": "string",
"description": "The object type of the data labeling job.\n"
},
"totalObject": {
"type": "integer",
"description": "The total number of objects to be labeled.\n"
}
}
}
GetDataQueryJobResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DataQueryJob"
}
}
}
GetDataQueryJobsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataQueryJob"
},
"description": "List of data query jobs. The query jobs are listed in reverse order of creation.\n"
}
}
}
GetDebitMemoApplicationPartCollectionType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"applicationParts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetDebitMemoApplicationPartType"
},
"description": "Container for application parts.\n"
}
}
}
GetDebitMemoApplicationPartType
{
"type": "object",
"title": "applicationParts",
"properties": {
"paymentId": {
"type": "string",
"format": "uuid",
"description": "The ID of the payment that is applied to the specified debit memo.\n"
},
"createdById": {
"type": "string",
"format": "uuid",
"description": "The ID of the Zuora user who created the payment or credit memo.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment or credit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-12-01 15:31:10.\n"
},
"updatedById": {
"type": "string",
"format": "uuid",
"description": "The ID of the Zuora user who last updated the payment or credit memo.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment or credit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2018-01-02 11:42:16.\n"
},
"creditMemoId": {
"type": "string",
"format": "uuid",
"description": "The ID of credit memo that is applied to the specified debit memo.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The amount that is applied to the debit memo.\n"
}
}
}
GetDebitMemoPdfStatusBatchResponse
{
"type": "object",
"title": "debitMemoFiles",
"example": {
"success": true,
"debitMemoFiles": [
{
"createdOn": "2024-01-01 11:32:19",
"updatedOn": "2024-01-01 11:32:19",
"debitMemoId": "402824aa8cc894d5018cc8a120576881",
"debitMemoNumber": "DM00000003",
"pdfGenerationStatus": "Pending"
},
{
"createdOn": "2024-01-02 10:14:13",
"updatedOn": "2024-01-02 10:14:13",
"debitMemoId": "407624ab8cd894d5018cc8a155636987",
"debitMemoNumber": "DM00000004",
"pdfGenerationStatus": "Generated"
}
]
},
"properties": {
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded.\n"
},
"debitMemoFiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetDebitMemoPdfStatusResponse"
},
"description": "Array of debit memo PDF statuses requested.\n"
}
},
"description": ""
}
GetDebitMemoPdfStatusResponse
{
"allOf": [
{
"type": "object",
"properties": {
"createdOn": {
"type": "string",
"description": "The time at which the request to generate the PDF was created.\n"
},
"updatedOn": {
"type": "string",
"description": "The time at which the request to generate the PDF was updated.\n"
},
"debitMemoId": {
"type": "string",
"description": "The ID of the debit memo whose pdf status is requested.\n"
},
"debitMemoNumber": {
"type": "string",
"description": "The debit memo number of the debit memo whose pdf status is requested.\n"
},
"pdfGenerationStatus": {
"enum": [
"None",
"Pending",
"Processing",
"Generated",
"Error",
"Obsolete",
"Archived"
],
"type": "string",
"description": "The generation status of the debit memo PDF.\n"
}
}
}
]
}
GetDescribe404Response
{
"type": "string"
}
GetDescribeResponse
{
"type": "string"
}
GetEInvoiceFileTemplateResponse
{
"allOf": [
{
"type": "object",
"title": "templates",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the e-invoice file template.\n"
},
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the e-invoice file template.\n"
},
"content": {
"type": "string",
"description": "The content of the e-invoice file template, which must be encoded in Base64 format.\n"
},
"country": {
"type": "boolean",
"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 <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions\" target=\"_blank\">View countries or regions</a>.\n"
},
"provider": {
"enum": [
"Sovos"
],
"type": "string",
"description": "The name of the e-invoicing service provider that assists in generating e-invoice files for billing documents. \n"
},
"documentType": {
"enum": [
"Invoice",
"CreditMemo",
"DebitMemo"
],
"type": "string",
"description": "The type of billing document for which the e-invoice file template is intended.\n"
},
"templateNumber": {
"type": "string",
"description": "The unique number of the e-invoice file template.\n"
}
}
}
]
}
GetEInvoicingBusinessRegionResponse
{
"allOf": [
{
"type": "object",
"title": "regions",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the e-invoicing business region.\n"
},
"city": {
"type": "string",
"description": "The the name of the city where the business is located.\n"
},
"email": {
"type": "string",
"nullable": true,
"description": "The email address of the Seller contact to receive e-invoicing data.\n"
},
"state": {
"type": "string",
"nullable": true,
"description": "The name of the state or province where the business is located.\n"
},
"country": {
"type": "string",
"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 <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions\" target=\"_blank\">View countries or regions</a>.\n"
},
"success": {
"type": "boolean",
"description": "Indicats if the request succeeds.\n"
},
"tradeName": {
"type": "string",
"nullable": true,
"maxLength": 100,
"description": "The name that the Seller is known as, other than the legal business name.\n"
},
"endpointId": {
"type": "string",
"description": "The Seller's electronic address, to which the application-level response to the e-invoice file might be delivered.\n"
},
"postalCode": {
"type": "string",
"description": "The short code that can identify the business address.\n"
},
"contactName": {
"type": "string",
"nullable": true,
"maxLength": 255,
"description": "The name of the Seller contact to receive e-invoicing data.\n"
},
"phoneNumber": {
"type": "string",
"nullable": true,
"description": "The business phone number of the Seller contact to receive e-invoicing data.\n"
},
"addressLine1": {
"type": "string",
"nullable": true,
"description": "The first line of the Seller’s address, which is often a street address or business name.\n"
},
"addressLine2": {
"type": "string",
"nullable": true,
"description": "The second line of the Seller’s address, which is often the name of a building.\n"
},
"businessName": {
"type": "string",
"maxLength": 255,
"description": "The full official name that the Seller is registered with the relevant legal authority.\n"
},
"businessNumber": {
"type": "string",
"description": "The specify the unique identifier number of the legal entity or person that you do business with.\n\nFor example, you must use a GSTIN for India and Tax Identification Number (TIN) for Saudi Arabia.\n"
},
"responseMapping": {
"type": "object",
"title": "responseMapping",
"description": "Container for e-invoicing response field mappings that map values from Sovos response data to fields on the EInvoiceData object in Zuora. Each response field mapping consists of a field name and a field path.\n\nNote that this field is applicable only to the Sovos service provider.\n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings\" target=\"_blank\">Configure e-invoicing response field mappings</a>.\n",
"additionalProperties": {
"type": "string",
"description": "The response field mapping consists of a key-value pair:\n\n* Field name: the name of the field on the EInvoiceData object (except for the `EInvoiceFile` field). <br>Zuora supports the following field names. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Supported_response_fields\" target=\"_blank\">Supported response fields</a>.\n * `AuthorizationCode`\n * `EInvoiceFile`\n * `QrCode`\n * `ReferenceNumber`\n * `Field1` to `Field10`\n\n* Field value: the path of an XML node in the e-invoicing response data from Sovos. The value of this field must be compliant with the <a href=\"https://www.w3schools.com/xml/xpath_intro.asp\" target=\"_blank\">XPath</a> syntax. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Field_path_format\" target=\"_blank\">Field path format</a>.\n"
}
},
"endpointSchemeId": {
"type": "string",
"description": "The identification scheme identifier of the Seller’s electronic address.\n"
},
"serviceProviderId": {
"type": "string",
"description": "The unique ID of the e-invoicing service provider that is associated to the business region.\n"
},
"taxRegisterNumber": {
"type": "string",
"nullable": true,
"description": "The Seller's VAT identifier (also known as Seller VAT identification number) or the local identification (defined by the Seller’s address) of the Seller for tax purposes, or a reference that enables the Seller to state the registered tax status.\n"
},
"businessRegionNumber": {
"type": "string",
"description": "The unique number of the e-invoicing business region.\n"
},
"businessNumberSchemaId": {
"type": "string",
"description": "The identification scheme identifier that an official registrar issues to identify the Seller as a legal entity or person.\n"
},
"digitalSignatureEnable": {
"type": "boolean",
"default": false,
"description": "Whether the e-invoicing service provider signs PDF files for billing documents.\n"
},
"digitalSignatureBoxPosX": {
"type": "number",
"minimum": 0,
"description": "The X-coordinate to determine where the digital signature box is displayed on PDF files for billing documents.\n"
},
"digitalSignatureBoxPosY": {
"type": "number",
"minimum": 0,
"description": "The Y-coordinate to determine where the digital signature box is displayed on PDF files for billing documents. \n"
},
"digitalSignatureBoxEnable": {
"type": "boolean",
"default": false,
"description": "Whether the digital signature box is displayed on PDF files for billing documents.\n"
}
}
}
]
}
GetEInvoicingServiceProviderResponse
{
"allOf": [
{
"type": "object",
"title": "serviceProviders",
"properties": {
"id": {
"type": "string",
"description": "The ID of the e-invoicing service provider.\n"
},
"name": {
"type": "string",
"maxLength": 100,
"description": "The name of the e-invoicing service provider.\n"
},
"test": {
"type": "boolean",
"description": "Whether the e-invoicing service provider's configuration is intended for testing. \n\n- If you set this field to `true`, requests are directed to the testing integration endpoints.\n- If you set this field to `false`, requests are directed to the production integration endpoints.\n"
},
"apiKey": {
"type": "string",
"description": "The API key is used to authenticate the e-invoicing service provider's requests.\n"
},
"provider": {
"enum": [
"Sovos",
"PEPPOL"
],
"type": "string",
"description": "The name of the e-invoicing service provider that can help you generate e-invoice files for billing documents.\n"
},
"clientCertificate": {
"type": "string",
"format": "byte",
"description": "The client certificate is used to authenticate the e-invoicing service provider's requests, which should be in base64 encoded format.\n"
},
"companyIdentifier": {
"type": "string",
"description": "The identifier of the company used to create a sender system ID, which serves to identify the system where the transactions are sent.\n"
},
"clientCertificateType": {
"type": "string",
"default": "PKCS12",
"description": "The client certificate type is used to authenticate the e-invoicing service provider's requests. \n"
},
"serviceProviderNumber": {
"type": "string",
"description": "The unique number of the e-invoicing service provider.\n"
}
}
}
]
}
GetEventTriggersResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventTrigger"
}
},
"next": {
"type": "string",
"description": "The link to the next page. No value if it is last page."
}
}
}
GetFulfillmentItemResponseType
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"fulfillmentItem": {
"$ref": "#/components/schemas/FulfillmentItemGet"
}
}
}
]
}
GetFulfillmentResponseType
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"fulfillment": {
"$ref": "#/components/schemas/FulfillmentGet"
}
}
}
]
}
GetHostedPageType
{
"type": "object",
"title": "hostedpages",
"properties": {
"pageId": {
"type": "string",
"description": "Page ID of the Payment Page that Zuora assigns when it is created.\n"
},
"pageName": {
"type": "string",
"description": "Name of the Payment Page that specified during the page configuration.\n"
},
"pageType": {
"type": "string",
"description": "Payment method type of this Payment Page, e.g. 'Credit Card', 'ACH', or 'Bank Transfer'.\n"
},
"pageVersion": {
"type": "string",
"description": "Version of the Payment Page. 2 for Payment Pages 2.0.\n"
}
}
}
GetHostedPagesType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"hostedpages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetHostedPageType"
},
"description": "Container for the hosted page information.\n"
}
}
}
GetInvoiceApplicationPartCollectionType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"applicationParts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetInvoiceApplicationPartType"
},
"description": "Container for application parts.\n"
}
}
}
GetInvoiceApplicationPartType
{
"type": "object",
"title": "applicationParts",
"properties": {
"paymentId": {
"type": "string",
"format": "uuid",
"description": "The ID of the payment that is applied to the specified invoice.\n"
},
"createdById": {
"type": "string",
"format": "uuid",
"description": "The ID of the Zuora user who created the payment or credit memo.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment or credit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-12-01 15:31:10.\n"
},
"updatedById": {
"type": "string",
"format": "uuid",
"description": "The ID of the Zuora user who last updated the payment or credit memo.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment or credit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2018-01-02 11:42:16.\n"
},
"creditMemoId": {
"type": "string",
"format": "uuid",
"description": "The ID of credit memo that is applied to the specified invoice.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The amount that is applied to the invoice.\n"
}
}
}
GetInvoicePdfStatusBatchResponse
{
"type": "object",
"title": "invoiceFiles",
"example": {
"success": true,
"invoiceFiles": [
{
"createdOn": "2024-01-01 11:35:56",
"invoiceId": "402824aa8cc894d5018cc8a120576881",
"updatedOn": "2024-01-01 11:35:56",
"invoiceNumber": "INV00000003",
"pdfGenerationStatus": "Pending"
},
{
"createdOn": "2024-01-02 10:14:13",
"invoiceId": "407624ab8cd894d5018cc8a155636987",
"updatedOn": "2024-01-02 10:14:13",
"invoiceNumber": "INV00000004",
"pdfGenerationStatus": "Generated"
}
]
},
"properties": {
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded.\n"
},
"invoiceFiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetInvoicePdfStatusResponse"
},
"description": "Array of invoice PDF statuses requested.\n"
}
},
"description": ""
}
GetInvoicePdfStatusResponse
{
"allOf": [
{
"type": "object",
"properties": {
"createdOn": {
"type": "string",
"description": "The time at which the request to generate the PDF was created.\n"
},
"invoiceId": {
"type": "string",
"description": "The ID of the invoice whose pdf status is requested.\n"
},
"updatedOn": {
"type": "string",
"description": "The time at which the request to generate the PDF was updated.\n"
},
"invoiceNumber": {
"type": "string",
"description": "The invoice number of the invoice whose pdf status is requested.\n"
},
"pdfGenerationStatus": {
"enum": [
"None",
"Pending",
"Processing",
"Generated",
"Error",
"Obsolete",
"Archived"
],
"type": "string",
"description": "The generation status of the invoice PDF.\n"
}
}
}
]
}
GetJobStatusAndResponseResponse
{
"type": "object",
"properties": {
"errors": {
"type": "string",
"description": "Error messages returned if the job failed."
},
"result": {
"$ref": "#/components/schemas/JobResult"
},
"status": {
"enum": [
"Processing",
"Failed",
"Completed"
],
"type": "string",
"description": "Type of job status."
},
"success": {
"type": "boolean",
"description": "Indicates whether the operation call succeeded."
}
}
}
GetListBookingDateBackfillJobsResponse
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETBookingDateJobResponse"
}
}
}
}
]
}
GetListDataBackfillJobsResponse
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataBackfillJob"
}
}
}
}
]
}
GetOpenPaymentMethodTypePublishResponse
{
"type": "object",
"example": {
"label": "ZuoraQA Amazon Pay",
"fields": [
{
"name": "AmazonToken",
"type": "string",
"index": 1,
"label": "AmazonToken",
"visible": true,
"checksum": true,
"editable": true,
"required": true,
"maxLength": 100,
"minLength": 1,
"description": "The Token value",
"representer": true,
"defaultValue": null
},
{
"name": "AmazonTokenType",
"type": "string",
"index": 2,
"label": "Amazon TokenType",
"visible": true,
"checksum": true,
"editable": true,
"required": true,
"maxLength": 100,
"minLength": 1,
"description": "The Type of Token, e.g. GoCardlessToken",
"representer": true,
"defaultValue": null
}
],
"status": "Published",
"version": "2021-11-22",
"entityId": "f707d981-3ad2-4484-9c24-a93bf6b83411",
"revision": 1,
"tenantId": "9",
"internalName": "AmazonPay",
"subTypeField": "AmazonTokenType",
"userReferenceIdField": "AmazonAccount",
"methodReferenceIdField": "AmazonToken"
},
"properties": {
"label": {
"type": "string",
"example": "ZuoraQA Amazon Pay"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "AmazonToken"
},
"type": {
"type": "string",
"example": "string"
},
"index": {
"type": "number",
"example": 1
},
"label": {
"type": "string",
"example": "AmazonToken"
},
"visible": {
"type": "boolean",
"example": true
},
"checksum": {
"type": "boolean",
"example": true
},
"editable": {
"type": "boolean",
"example": true
},
"required": {
"type": "boolean",
"example": true
},
"maxLength": {
"type": "number",
"example": 100
},
"minLength": {
"type": "number",
"example": 1
},
"description": {
"type": "string",
"example": "The Token value"
},
"representer": {
"type": "boolean",
"example": true
},
"defaultValue": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
}
}
}
},
"status": {
"type": "string",
"example": "Published"
},
"version": {
"type": "string",
"example": "2021-11-22"
},
"entityId": {
"type": "string",
"example": "f707d981-3ad2-4484-9c24-a93bf6b83411"
},
"revision": {
"type": "number",
"example": 1
},
"tenantId": {
"type": "string",
"example": "9"
},
"internalName": {
"type": "string",
"example": "AmazonPay"
},
"subTypeField": {
"type": "string",
"example": "AmazonTokenType"
},
"userReferenceIdField": {
"type": "string",
"example": "AmazonAccount"
},
"methodReferenceIdField": {
"type": "string",
"example": "AmazonToken"
}
}
}
GetOpenPaymentMethodTypeRevisionResponse
{
"type": "object",
"example": {
"label": "ZuoraQA Amazon Pay",
"fields": [
{
"name": "AmazonToken",
"type": "string",
"index": 1,
"label": "AmazonToken",
"visible": true,
"checksum": true,
"editable": true,
"required": true,
"maxLength": 100,
"minLength": 1,
"description": "The Token value",
"representer": true,
"defaultValue": null
},
{
"name": "AmazonTokenType",
"type": "string",
"index": 2,
"label": "Amazon TokenType",
"visible": true,
"checksum": true,
"editable": true,
"required": true,
"maxLength": 100,
"minLength": 1,
"description": "The Type of Token, e.g. GoCardlessToken",
"representer": true,
"defaultValue": null
}
],
"status": "Published",
"version": "2021-11-22",
"entityId": "f707d981-3ad2-4484-9c24-a93bf6b83411",
"revision": 1,
"tenantId": "9",
"internalName": "AmazonPay",
"subTypeField": "AmazonTokenType",
"userReferenceIdField": "AmazonAccount",
"methodReferenceIdField": "AmazonToken"
},
"properties": {
"label": {
"type": "string",
"example": "ZuoraQA Amazon Pay"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "AmazonToken"
},
"type": {
"type": "string",
"example": "string"
},
"index": {
"type": "number",
"example": 1
},
"label": {
"type": "string",
"example": "AmazonToken"
},
"visible": {
"type": "boolean",
"example": true
},
"checksum": {
"type": "boolean",
"example": true
},
"editable": {
"type": "boolean",
"example": true
},
"required": {
"type": "boolean",
"example": true
},
"maxLength": {
"type": "number",
"example": 100
},
"minLength": {
"type": "number",
"example": 1
},
"description": {
"type": "string",
"example": "The Token value"
},
"representer": {
"type": "boolean",
"example": true
},
"defaultValue": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
}
}
}
},
"status": {
"type": "string",
"example": "Published"
},
"version": {
"type": "string",
"example": "2021-11-22"
},
"entityId": {
"type": "string",
"example": "f707d981-3ad2-4484-9c24-a93bf6b83411"
},
"revision": {
"type": "number",
"example": 1
},
"tenantId": {
"type": "string",
"example": "9"
},
"internalName": {
"type": "string",
"example": "AmazonPay"
},
"subTypeField": {
"type": "string",
"example": "AmazonTokenType"
},
"userReferenceIdField": {
"type": "string",
"example": "AmazonAccount"
},
"methodReferenceIdField": {
"type": "string",
"example": "AmazonToken"
}
}
}
GetOperationJobResponseType
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the operation job to retrieve information about.\n"
},
"status": {
"enum": [
"Pending",
"Processing",
"Failed",
"Completed"
],
"type": "string",
"description": "The status of the operation job. \n"
},
"reasons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The error code of the response.\n"
},
"message": {
"type": "string",
"description": "The detail information of the error response.\n"
}
}
}
},
"success": {
"type": "boolean",
"description": "Whether the call succeeded.\n"
},
"objectId": {
"type": "string",
"description": "The ID of the business object which is being operated.\n"
},
"objectType": {
"enum": [
"Invoice"
],
"type": "string",
"description": "The object type of the job. \n"
},
"operationType": {
"enum": [
"Delete"
],
"type": "string",
"description": "The operation type of the job.\n"
}
}
}
GetOrderActionRatePlanResponse
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique subscription rate-plan ID."
},
"order": {
"$ref": "#/components/schemas/OrderActionRatePlanOrder"
},
"amendment": {
"$ref": "#/components/schemas/OrderActionRatePlanAmendment"
},
"productId": {
"type": "string",
"description": "Product ID\n"
},
"productSku": {
"type": "string",
"description": "The unique SKU for the product.\n"
},
"productName": {
"type": "string",
"description": "The name of the product.\n"
},
"ratePlanName": {
"type": "string",
"description": "The name of the rate plan.\n"
},
"lastChangeType": {
"type": "string",
"description": "Latest change type. Possible values are:\n\n- New\n- Update\n- Remove\n"
},
"subscriptionId": {
"type": "string",
"description": "Subscription ID.\n"
},
"productRatePlanId": {
"type": "string",
"description": "Product rate plan ID\n"
},
"subscriptionVersion": {
"description": "The version of the subscription.\n"
},
"externallyManagedPlanId": {
"type": "string",
"description": "The unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n"
}
}
}
]
}
GetOrderLineItemResponseType
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"orderLineItem": {
"$ref": "#/components/schemas/OrderLineItem"
}
}
}
]
}
GetOrderResponse
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"order": {
"$ref": "#/components/schemas/Order"
}
}
}
]
}
GetOrderResume
{
"type": "object",
"title": "Resume",
"properties": {
"resumeDate": {
"type": "string",
"format": "date",
"description": "The resume date when the resumption takes effect.\n"
},
"extendsTerm": {
"type": "boolean",
"description": "Specifies whether to extend the subscription term by the length of time the suspension is in effect. Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration.\n"
},
"resumePolicy": {
"enum": [
"Today",
"FixedPeriodsFromSuspendDate",
"FixedPeriodsFromToday",
"SpecificDate",
"SuspendDate"
],
"type": "string",
"description": "Resume methods. Specify a way to resume a subscription. See [Resume Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Resume_a_Subscription#Resume_Date) for more information. Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration.\n\nIf `SuspendDate` is specfied, the resumption will take place on the same day as the suspension. \n"
},
"resumePeriods": {
"type": "integer",
"description": "This field is applicable only when the `resumePolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must be used together with the `resumePeriodsType` field. Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration.\n\nThe total number of the periods used to specify when a subscription resumption takes effect. The subscription resumption will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
},
"resumePeriodsType": {
"enum": [
"Day",
"Week",
"Month",
"Year"
],
"type": "string",
"description": "This field is applicable only when the `resumePolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must be used together with the `resumePeriods` field. Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration.\n\nThe period type used to specify when a subscription resumption takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
},
"resumeSpecificDate": {
"type": "string",
"format": "date",
"description": "This field is applicable only when the `resumePolicy` field is set to `SpecificDate`. Note this field is not applicable in a Resume order action auto-created by the Order Metrics migration.\n\nA specific date when the subscription resumption takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription suspension date.\n"
}
},
"description": "Information about an order action of type `Resume`.\n"
}
GetOrderSuspend
{
"type": "object",
"title": "Suspend",
"properties": {
"suspendDate": {
"type": "string",
"format": "date",
"description": "The suspend date when the suspension takes effect. \n"
},
"suspendPolicy": {
"enum": [
"Today",
"EndOfLastInvoicePeriod",
"FixedPeriodsFromToday",
"SpecificDate"
],
"type": "string",
"description": "Suspend methods. Specify a way to suspend a subscription. See [Suspend Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Suspend_a_Subscription#Suspend_Date) for more information. Note this field is not applicable in a Suspend order action auto-created by the Order Metrics migration.\n"
},
"suspendPeriods": {
"type": "integer",
"description": "This field is applicable only when the `suspendPolicy` field is set to `FixedPeriodsFromToday`. It must be used together with the `suspendPeriodsType` field. Note this field is not applicable in a Suspend order action auto-created by the Order Metrics migration.\n\nThe total number of the periods used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
},
"suspendPeriodsType": {
"enum": [
"Day",
"Week",
"Month",
"Year"
],
"type": "string",
"description": "This field is applicable only when the `suspendPolicy` field is set to `FixedPeriodsFromToday`. It must be used together with the `suspendPeriods` field. Note this field is not applicable in a Suspend order action auto-created by the Order Metrics migration.\n\nThe period type used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"
},
"suspendSpecificDate": {
"type": "string",
"format": "date",
"description": "This field is applicable only when the `suspendPolicy` field is set to `SpecificDate`. Note this field is not applicable in a Suspend order action auto-created by the Order Metrics migration.\n\nA specific date when the subscription suspension takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription's contract effective date or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) than the subscription's term end date.\n"
}
},
"description": "Information about an order action of type `Suspend`.\n"
}
GetOrdersResponse
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
}
}
]
}
GetPaymentVolumeSummaryResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentVolumeSummaryRecord"
},
"description": "List of electronic payments summary.\n"
}
}
}
GetProductFeatureType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Feature ID.\n"
},
"code": {
"type": "string",
"description": "Feature code, up to 255 characters long.\n"
},
"name": {
"type": "string",
"description": "Feature name, up to 255 characters long.\n"
},
"status": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": "Feature description.\n"
}
}
},
{
"$ref": "#/components/schemas/ProductFeatureObjectCustomFields"
}
],
"title": "productFeatures"
}
GetScheduledEventResponse
{
"type": "object",
"title": "ScheduledEvent",
"example": {
"id": "d306545b74e445e4bffcf1c7609804be",
"name": "TermEndDateScheduledEvent",
"active": true,
"apiField": "TermEndDate",
"apiObject": "Subscription",
"condition": "Subscription.Status == _SUBSCRIPTION_STATUS",
"namespace": "user.notification",
"parameters": {
"_SUBSCRIPTION_STATUS": {
"options": [
"Draft",
"Active",
"Pending",
"Expired",
"Cancelled"
],
"valueType": "STRING",
"description": "The status of the subscription",
"displayName": "Subscription Status"
}
},
"description": "Trigger a scheduled event at 10:30 AM based on TermEndDate of subscription objects.",
"displayName": "Term End Date Scheduled Event",
"cronExpression": "0 30 10 ? * *"
},
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Scheduled event ID."
},
"name": {
"type": "string",
"description": "The name of the scheduled event."
},
"active": {
"type": "boolean",
"description": "Indicate whether the scheduled event is active or inactive"
},
"apiField": {
"type": "string",
"description": "The base field of the base object in the `apiObject` field, should be in date or timestamp format. The scheduled event notifications are triggered based on this date and the event parameters (before or after a specified number of days) from notification definitions. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$"
},
"apiObject": {
"type": "string",
"description": "The base object that the scheduled event is defined upon. The base object should contain a date or timestamp format field. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$"
},
"condition": {
"type": "string",
"description": "The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The scheduled event is triggered only if the condition is evaluated as true.\nThe rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects).\nScheduled events with invalid merge fields will fail to evaluate, thus will not be triggered. For example, to trigger an invoice due date scheduled event to only invoices with an amount over 1000, you would define the following condition:\n\n```Invoice.Amount > 1000```\n\n`Invoice.Amount` refers to the `Amount` field of the Zuora object `Invoice`.\n"
},
"namespace": {
"type": "string",
"description": "The namespace of the scheduled event name in the `name` field."
},
"parameters": {
"type": "object",
"description": "The parameter definitions of the filter rule. The names of the parameters must match with the filter rule and can't be duplicated. You should specify all the parameters when creating scheduled event notifications.",
"additionalProperties": {
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "The option values of the parameter."
},
"valueType": {
"type": "string",
"description": "The type of the value."
},
"description": {
"type": "string",
"maxLength": 255,
"description": "The description of the parameter."
},
"displayName": {
"type": "string",
"maxLength": 255,
"description": "The display name of the parameter."
}
},
"description": "Definition of a filter rule parameter."
}
},
"description": {
"type": "string",
"description": "The description of the scheduled event."
},
"displayName": {
"type": "string",
"description": "The display name of the scheduled event."
},
"cronExpression": {
"type": "string",
"description": "The cron expression defines the time when scheduled event notifications will be sent."
}
}
}
GetScheduledEventsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetScheduledEventResponse"
}
},
"next": {
"type": "string",
"example": "/events/scheduled-events?start=10&limit=10",
"description": "The link to the next page. No value if it is last page."
}
}
}
GetStoredCredentialProfilesResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"profiles": {
"type": "array",
"items": {
"properties": {
"type": {
"enum": [
"Recurring",
"Unscheduled"
],
"type": "string"
},
"brand": {
"type": "string",
"description": "The stored credential transaction framework. For example, Visa.\n"
},
"number": {
"type": "integer",
"description": "The number that identifies the stored credential profile within the payment method.\n"
},
"status": {
"enum": [
"Agreed",
"Active",
"Cancelled",
"Expired"
],
"type": "string",
"description": "The status of the stored credential profile.\n\n* `Agreed` - The stored credential profile has not been validated via an authorization transaction with the payment gateway.\n* `Active` - The stored credential profile has been validated via an authorization transaction with the payment gateway.\n* `Cancelled` - The stored credentials are no longer valid, per a customer request. Zuora cannot use the stored credentials in transactions.\n* `Expired` - The stored credentials are no longer valid, per an expiration policy in the stored credential transaction framework. Zuora cannot use the stored credentials in transactions.\n"
},
"agreedOn": {
"type": "string",
"format": "date-time",
"description": "The date when the stored credential profile was created.\n"
},
"expiredOn": {
"type": "string",
"format": "date-time",
"description": "The date when the stored credential profile was expired (if applicable).\n"
},
"activatedOn": {
"type": "string",
"format": "date-time",
"description": "The date when the stored credential profile was activated (if applicable).\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date when the stored credential profile was cancelled (if applicable).\n"
},
"paymentMethodId": {
"type": "string",
"description": "ID of the payment method.\n"
},
"consentAgreementRef": {
"type": "string",
"maxLength": 128,
"description": "Your reference for the consent agreement that you have established with the customer.\n"
},
"consentAgreementSrc": {
"enum": [
"External"
],
"type": "string"
}
}
},
"description": "Container for stored credential profiles.\n"
}
}
}
GetVersionsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Workflow"
},
"description": "The list of workflow versions retrieved. \n"
}
}
}
GetWorkflowExport404Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowError"
},
"description": "The list of errors returned from the workflow"
}
}
}
GetWorkflowExportResponse
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowError"
},
"description": "The list of errors returned from the workflow"
}
}
}
GetWorkflowResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the workflow.\n"
},
"name": {
"type": "string",
"description": "The unique run number of the workflow.\n"
},
"type": {
"type": "string",
"description": "The type of the current workflow. Possible values:\n - `Workflow::Setup`: The workflow is a setup and is used for creating workflow instances.\n - `Workflow::Instance`: The workflow is an execution that has data.\n"
},
"tasks": {
"type": "object",
"properties": {
"error": {
"type": "integer",
"description": "The number of tasks in **Error** state.\n"
},
"total": {
"type": "integer",
"description": "The total number of tasks.\n"
},
"queued": {
"type": "integer",
"description": "The number of tasks in **Queued** state.\n"
},
"pending": {
"type": "integer",
"description": "The number of tasks in **Pending** state.\n"
},
"stopped": {
"type": "integer",
"description": "The number of tasks in **Stopped** state.\n"
},
"success": {
"type": "integer",
"description": "The number of tasks in **Success** state.\n"
},
"processing": {
"type": "integer",
"description": "The number of tasks in **Processing** state.\n"
}
},
"description": "An object containing task counts.\n"
},
"status": {
"enum": [
"Queued",
"Processing",
"Stopping",
"Stopped",
"Finished"
],
"type": "string",
"description": "The status of the workflow:\n - Queued: The workflow is in queue for being processed.\n - Processing: The workflow is in process.\n - Stopping: The workflow is being stopped through Zuora UI.\n - Stopped: The workflow is stopped through Zuora UI.\n - Finished: The workflow is finished. When a workflow is finished, it might have tasks pending for retry or delay. Pending tasks do not block the onfinish branch of the workflow, but they block the oncomplete branch of the iterate. \n"
},
"cpuTime": {
"type": "string",
"format": "time",
"description": "The overall CPU time for the execution of the workflow.\n"
},
"runTime": {
"type": "number",
"format": "double",
"description": "The execution time of the workflow including the waiting time, in seconds.\n"
},
"messages": {
"type": "object",
"description": "Messages from tasks. \n\n**Note:** This field is only returned in Production.\n"
},
"createdAt": {
"type": "string",
"format": "datetime",
"description": "The date and time when the workflow is created, in the `YYYY-MM-DD HH:MM:SS` format..\n"
},
"updatedAt": {
"type": "string",
"format": "datetime",
"description": "The date and time when the workflow is updated the last time, in the `YYYY-MM-DD HH:MM:SS` format.\n"
},
"finishedAt": {
"type": "string",
"format": "datetime",
"description": "The date and time when the execution of the workflow completes, in the `YYYY-MM-DD HH:MM:SS` format.\n"
},
"originalWorkflowId": {
"type": "string",
"description": "The ID of the workflow setup.\n"
}
}
}
GetWorkflowsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowDefinitionAndVersions"
},
"description": "The list of workflows retrieved. \n"
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "An integer denoting the current page number.\n"
},
"next_page": {
"type": "string",
"description": "A string containing the URL where the next page of data can be retrieved.\n"
},
"page_length": {
"type": "integer",
"description": "An integer denoting the number of workflows in this response. The maximum value is 50.\n"
}
},
"description": "An object containing pagination information for the list of workflows returned by the api\n"
}
}
}
InitialTerm
{
"type": "object",
"required": [
"termType"
],
"properties": {
"period": {
"type": "integer",
"minimum": 0,
"description": "Specify only when the termType is 'TERMED'."
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN"
],
"type": "string"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the current term.\n"
},
"periodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"description": "Specify only when the termType is 'TERMED'."
}
},
"description": "The length of the period for the current subscription term."
}
InvoiceEntityPrefix
{
"type": "object",
"title": "Invoice",
"properties": {
"prefix": {
"type": "string",
"example": "INV",
"description": "The prefix of invoices.\n"
},
"startNumber": {
"type": "integer",
"example": 10,
"description": "The starting document number of invoices.\n"
}
},
"description": "Container for the prefix and starting document number of invoices.\n"
}
InvoiceFile
{
"type": "object",
"title": "invoiceFiles",
"properties": {
"id": {
"type": "string",
"description": "The ID of the invoice PDF file. This is the ID for the file object and different from the file handle ID in the `pdfFileUrl` field. To open a file, you have to use the file handle ID.\n"
},
"pdfFileUrl": {
"type": "string",
"description": "The REST URL for the invoice PDF file. Click the URL to open the invoice PDF file.\n"
},
"versionNumber": {
"type": "integer",
"format": "int64",
"description": "The version number of the invoice PDF file.\n"
}
}
}
InvoiceItem
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Item ID."
},
"sku": {
"type": "string",
"description": "The SKU of the invoice item.\n"
},
"balance": {
"type": "string",
"format": "decimal",
"description": "The balance of the invoice item.\n\n**Note**: This field is only available if you have the Invoice Settlement feature enabled.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code of the invoice item.\n**Note** Only when taxation feature is enabled, this field can be presented.\n"
},
"taxMode": {
"type": "string",
"description": "The tax mode of the invoice item.\n**Note** Only when taxation feature is enabled, this field can be presented.\n"
},
"chargeId": {
"type": "string",
"description": "The unique ID of the charge."
},
"itemType": {
"type": "string",
"description": "The type of the invoice item.\n"
},
"quantity": {
"type": "string",
"format": "decimal",
"description": "The quantity of this item, in the configured unit of measure for the charge."
},
"taxAmount": {
"type": "string",
"format": "decimal",
"description": "Tax applied to the charge."
},
"unitPrice": {
"type": "number",
"format": "double",
"description": "The per-unit price of the invoice item."
},
"chargeDate": {
"type": "string",
"format": "date-time",
"description": "The date when the invoice item is charged, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"chargeName": {
"type": "string",
"description": "The name of the charge."
},
"chargeType": {
"enum": [
"OneTime",
"Recurring",
"Usage"
],
"type": "string",
"description": "The type of the charge. \n"
},
"revRecCode": {
"type": "string",
"description": "The revenue recognition code.\n"
},
"description": {
"type": "string",
"description": "The description of the invoice item."
},
"productName": {
"type": "string",
"description": "Name of the product associated with this item."
},
"chargeAmount": {
"type": "string",
"format": "decimal",
"description": "The amount of the charge. \n\nThis amount does not include taxes regardless if the charge's tax mode is inclusive or exclusive.\n"
},
"fulfillmentId": {
"type": "string",
"description": "The reference ID of the fulfillment associated with the invoice item.\n"
},
"taxationItems": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETInvoiceTaxItemType"
},
"description": "List of taxation items.\n"
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": "Container for the taxation items of the invoice item. \n"
},
"unitOfMeasure": {
"type": "string",
"description": "Unit used to measure consumption."
},
"accountingCode": {
"type": "string",
"description": "The accounting code associated with the invoice item."
},
"processingType": {
"enum": [
"Charge",
"Discount",
"Prepayment",
"Tax",
"Rounding"
],
"type": "string",
"description": "The kind of the charge for the invoice item. \n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The end date of the service period for this item, i.e., the last day of the service period, as _yyyy-mm-dd_."
},
"sourceItemType": {
"enum": [
"SubscriptionComponent",
"Rounding",
"ProductRatePlanCharge",
"None",
"OrderLineItem"
],
"type": "string",
"description": "The type of the source item.\n"
},
"subscriptionId": {
"type": "string",
"description": "The ID of the subscription for this item."
},
"appliedToItemId": {
"type": "string",
"description": "The unique ID of the invoice item that the discount charge is applied to."
},
"orderLineItemId": {
"type": "string",
"description": "The reference ID of the oder line item associated with the invoice item.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the invoice item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"bookingReference": {
"type": "string",
"description": "The booking reference of the invoice item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The start date of the service period for this item, as _yyyy-mm-dd_. For a one-time fee item, the date of the charge."
},
"subscriptionName": {
"type": "string",
"description": "The name of the subscription for this item."
},
"chargeDescription": {
"type": "string",
"description": "The description of the charge."
},
"invoiceScheduleId": {
"type": "string",
"description": "The ID of the invoice schedule item by which Invoice Schedule Item the invoice item is generated by when the Invoice Schedule Item is executed.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"numberOfDeliveries": {
"type": "number",
"description": "The number of deliveries dedicated to the Delivery Pricing charges.\n**Note**: This field is available only if you have the Delivery Pricing feature enabled.\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "The purchase order number associated with the invoice item.\n"
},
"invoiceScheduleItemId": {
"type": "string",
"description": "The ID of the invoice schedule item associated with the invoice item.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"revRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate"
],
"type": "string",
"description": "The date when revenue recognition is triggered.\n"
},
"availableToCreditAmount": {
"type": "number",
"format": "decimal",
"description": "The amount of the invoice item that is available to credit. \n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of the product rate plan charge that the invoice item is created from.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the invoice item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The revenue recognition rule of the invoice item.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"contractAssetAccountingCode": {
"type": "string",
"description": "The accounting code for contract asset. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The deferred revenue accounting code associated with the invoice item.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment revenue. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for contract liability. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The recognized revenue accounting code associated with the invoice item.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment liability. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"unbilledReceivablesAccountingCode": {
"type": "string",
"description": "The accounting code for unbilled receivables. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for contract recognized revenue. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the invoice item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/InvoiceItemObjectNSFields"
},
{
"$ref": "#/components/schemas/InvoiceItemObjectCustomFields"
}
],
"title": "invoiceItems"
}
InvoiceItemObjectCustomFields
{
"type": "object",
"title": "invoiceItemFieldsCustom",
"description": "Container for custom fields of an Invoice Item object.\n",
"additionalProperties": {
"description": "Custom fields of the Invoice Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
InvoiceItemObjectNSFields
{
"type": "object",
"title": "invoiceItemFieldsNS",
"properties": {
"SyncDate__NS": {
"type": "string",
"maxLength": 255,
"description": "Date when the invoice item was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationId__NS": {
"type": "string",
"maxLength": 255,
"description": "ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationStatus__NS": {
"type": "string",
"maxLength": 255,
"description": "Status of the invoice item's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
},
"description": "Container for Invoice Item fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
InvoiceItemPreviewResult
{
"type": "object",
"properties": {
"taxAmount": {
"type": "number"
},
"unitPrice": {
"type": "number",
"description": "The per-unit price of the invoice item.\n"
},
"chargeName": {
"type": "string"
},
"productName": {
"type": "string"
},
"chargeNumber": {
"type": "string",
"description": "Available when the `chargeNumber` field was specified in the request or when the order is amending an existing subscription."
},
"taxationItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the taxation item.\n"
},
"name": {
"type": "string",
"description": "The name of the taxation item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific invoice.\n"
},
"taxDate": {
"type": "string",
"description": "The date when the tax is applied to the invoice.\n"
},
"taxRate": {
"type": "number",
"description": "The tax rate applied to the invoice.\n"
},
"taxAmount": {
"type": "number",
"description": "The amount of the tax applied to the invoice.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "Enum:\"Percentage\" \"FlatFee\". The type of the tax rate applied to the invoice.\n"
},
"exemptAmount": {
"type": "number",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the taxCode field.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
}
}
},
"description": "List of taxation items.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `309.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"additionalInfo": {
"type": "object",
"properties": {
"quantity": {
"type": "number"
},
"unitOfMeasure": {
"type": "string"
},
"numberOfDeliveries": {
"type": "number",
"description": "The number of deliveries dedicated to the Delivery Pricing charges. \n**Note**: This field is available only if you have the Delivery Pricing feature enabled.\n"
}
}
},
"processingType": {
"enum": [
"Charge",
"Discount",
"Tax"
],
"type": "string"
},
"serviceEndDate": {
"type": "string",
"format": "date"
},
"amountWithoutTax": {
"type": "number"
},
"serviceStartDate": {
"type": "string",
"format": "date"
},
"chargeDescription": {
"type": "string"
},
"subscriptionNumber": {
"type": "string"
},
"orderLineItemNumber": {
"type": "string",
"description": "A sequential number auto-assigned for each of order line items in a order, used as an index, for example, \"1\"."
},
"appliedToChargeNumber": {
"type": "string",
"description": "Available when the chargeNumber of the charge that discount applies to was specified in the request or when the order is amending an existing subscription."
},
"productRatePlanChargeId": {
"type": "string"
}
}
}
InvoiceObjectCustomFields
{
"type": "object",
"title": "invoiceFieldsCustom",
"description": "Container for custom fields of an Invoice object.\n",
"additionalProperties": {
"description": "Custom fields of the Invoice object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
InvoiceObjectNSFields
{
"type": "object",
"title": "invoiceFieldsNS",
"properties": {
"SyncDate__NS": {
"type": "string",
"maxLength": 255,
"description": "Date when the invoice was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationId__NS": {
"type": "string",
"maxLength": 255,
"description": "ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationStatus__NS": {
"type": "string",
"maxLength": 255,
"description": "Status of the invoice's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
},
"description": "Container for Invoice fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
InvoicePostResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the invoice that was posted.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the invoice was posted successfully.\n"
}
}
}
]
}
InvoicePostType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the invoice to be posted.\n"
},
"invoiceDate": {
"type": "string",
"format": "date",
"description": "The date that appears on the invoice being created, in `yyyy-mm-dd` format. The value cannot fall in a closed accounting period.\n"
}
}
},
{
"$ref": "#/components/schemas/InvoiceObjectCustomFields"
}
]
}
InvoiceResponseType
{
"type": "object",
"title": "invoices",
"properties": {
"id": {
"type": "string",
"description": "The ID of the generated invoice.\n"
}
}
}
InvoiceScheduleCustomFields
{
"type": "object",
"title": "invoiceScheduleCustomFields",
"description": "Container for custom fields of an Invoice Schedule object.\n",
"additionalProperties": {
"description": "Custom fields of the Invoice Schedule object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
InvoiceScheduleItemCustomFields
{
"type": "object",
"title": "invoiceScheduleItemCustomFields",
"description": "Container for custom fields of an Invoice Schedule Item object.\n",
"additionalProperties": {
"description": "Custom fields of the Invoice Schedule Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
InvoiceScheduleResponses
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the invoice schedule.\n"
},
"notes": {
"type": "string",
"maxLength": 255,
"description": "Comments on the invoice schedule.\n"
},
"number": {
"type": "string",
"description": "The sequence number of the invoice schedule.\n"
},
"orders": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of the IDs or numbers of the orders associated with the invoice schedule. One invoice schedule can be associated with at most 10 orders.\n"
},
"status": {
"enum": [
"Pending",
"PartiallyProcessed",
"Paused",
"FullyProcessed"
],
"type": "string",
"description": "The status of the invoice schedule.\n"
},
"currency": {
"type": "string",
"description": "The currency of the billing documents generated during the processing of the invoice schedule.\n**Note**: - This field is available only if you have the <a\n href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\"\n target=\"_blank\">Multiple Currencies</a> feature enabled.\n\n- If you have the Multiple Currencies feature disabled, the corresponding account's default currency is always used.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account that the invoice schedule belongs to.\n"
},
"nextRunDate": {
"type": "string",
"format": "date",
"description": "The run date of the next execution of invoice schedule. By default, the next run date is the same as run date of next pending invoice schedule item. It can be overwritten with a different date other than the default value. When the invoice schedule has completed the execution, the next run date is null.\n"
},
"totalAmount": {
"type": "string",
"format": "number",
"description": "The total amount that needs to be billed during the processing of the invoice schedule. \n\nThe value of this field keeps unchanged once invoice schedule items are created.\n"
},
"actualAmount": {
"type": "string",
"format": "number",
"description": "The actual amount that needs to be billed during the processing of the invoice schedule.\n\nBy default, the actual amount is the same as the total amount. Even if order changes occur like Remove Product or Cancel Subscription, the value of the `totalAmount` field keeps unchanged. The value of the `actualAmount` field reflects the actual amount to be billed.\n"
},
"billedAmount": {
"type": "string",
"format": "number",
"description": "The amount that has been billed during the processing of the invoice schedule.\n"
},
"scheduleItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleItemsResponse"
},
"description": "Container for schedule items. One invoice schedule can have at most 50 invoice schedule items.\n"
},
"unbilledAmount": {
"type": "string",
"format": "number",
"description": "The amount that is waiting to be billed during the processing of the invoice schedule.\n"
},
"invoiceSeparately": {
"type": "boolean",
"description": "Whether the invoice items created from the invoice schedule appears on a separate invoice when Zuora generates invoices.\n"
},
"specificSubscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceScheduleSpecificSubscriptions"
},
"description": "A list of the numbers of specific subscriptions associated with the invoice schedule.\n"
},
"additionalSubscriptionsToBill": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of the numbers of the subscriptions that need to be billed together with the invoice schedule. \n\nOne invoice schedule can have at most 600 additional subscriptions.\n"
}
}
},
{
"$ref": "#/components/schemas/InvoiceScheduleCustomFields"
},
{}
]
}
InvoiceScheduleSpecificSubscriptions
{
"type": "object",
"title": "specificSubscriptions",
"properties": {
"orderKey": {
"type": "string",
"description": "The unique ID or number of the order associated with the invoice schedule.\n"
},
"chargeNumbers": {
"type": "string",
"description": "A list of charges in the subscription that are chosen to be included in the invoice schedule.\n"
},
"subscriptionKey": {
"type": "string",
"description": "The unique number of the subscription contained in the order associated with the invoice schedule.\n"
}
}
}
InvoiceWithCustomRatesType
{
"allOf": [
{
"type": "object",
"required": [
"currency",
"customFxRate"
],
"properties": {
"currency": {
"type": "string",
"description": "The currency code for either Reporting or Home currency.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"rateDate": {
"type": "string",
"format": "date",
"description": "The date on which a particular currency rate is fixed or obtained on.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"customFxRate": {
"type": "number",
"format": "decimal",
"description": "The Custom FX conversion rate between Home/Reporting and Transactional currency items.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
}
}
}
],
"title": "customRates"
}
InvoicesBatchPostResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request has one of invoices was posted successfully.\n"
},
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoicePostResponseType"
},
"title": "invoices",
"description": "The container for a list of posted invoices.\n"
}
}
}
]
}
JobResult
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"ramps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rampNumber": {
"type": "string",
"description": "The number of the ramp definition."
},
"subscriptionNumber": {
"type": "string",
"description": "The number of the subscription that this ramp deal definition is applied to."
}
}
},
"description": "**Note**: This field 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 [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020.\n\nThe ramp definitions created by this order request.\n"
},
"status": {
"enum": [
"Draft",
"Pending",
"Completed"
],
"type": "string",
"description": "Status of the order. `Pending` is only applicable for an order that contains a `CreateSubscription` order action."
},
"orderId": {
"type": "string",
"description": "The ID of the order created. This field is returned only when the `returnIds` query parameter in the \"Create an order asynchronously\" operation is set to `true`."
},
"accountId": {
"type": "string",
"description": "The account ID for the order. This field is returned only when the `returnIds` query parameter in the \"Create an order asynchronously\" operation is set to `true`."
},
"invoiceId": {
"type": "string",
"items": {
"type": "string"
},
"description": "An array of the invoice IDs that are generated in the \"Create an order asynchronously\" operation. This field is returned only when the `returnIds` query parameter in the \"Create an order asynchronously\" operation is set to `true`."
},
"paymentId": {
"type": "string",
"description": "The ID of the payment that is collected in the \"Create an order asynchronously\" operation. This field is returned only when the `returnIds` query parameter in the \"Create an order asynchronously\" operation is set to `true`."
},
"paidAmount": {
"type": "string",
"description": "The total amount collected in this order request."
},
"orderNumber": {
"type": "string",
"description": "The order number of the order created."
},
"accountNumber": {
"type": "string",
"description": "The account number for the order."
},
"creditMemoIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the credit memo IDs that are generated in the \"Create an order asynchronously\" operation. This field is returned only when the `returnIds` query parameter in the \"Create an order asynchronously\" operation is set to `true`."
},
"paymentNumber": {
"type": "string",
"description": "The payment number that collected in this order request."
},
"subscriptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"enum": [
"Active",
"Pending Activation",
"Pending Acceptance",
"Cancelled"
],
"type": "string",
"description": "Status of the subscription. `Pending Activation` and `Pending Acceptance` are only applicable for an order that contains a `CreateSubscription` order action."
},
"subscriptionNumber": {
"type": "string",
"description": "Subscription number of the subscription included in this order."
}
}
},
"description": "**Note:** This field is in Zuora REST API version control. Supported minor versions are 223.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header.\n\nContainer for the subscription numbers and statuses in an order.\n"
},
"invoiceNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the invoice numbers generated in this order request. Normally it includes one invoice number only, but can include multiple items when a subscription was tagged as invoice separately."
},
"orderLineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "UUID",
"description": "The sytem generated Id for the Order Line Item."
},
"itemNumber": {
"type": "string",
"format": "UUID",
"description": "The number for the Order Line Item."
}
}
}
},
"subscriptionIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Container for the IDs of the subscriptions in the order. This field is returned only when the `returnIds` query parameter in the \"Create an order asynchronously\" operation is set to `true`."
},
"creditMemoNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the credit memo numbers generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled."
},
"subscriptionNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "**Note:** This field is in Zuora REST API version control. Supported minor versions are 222.0 or earlier [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header.\n\nContainer for the subscription numbers of the subscriptions in an order.\n"
}
}
}
],
"description": "**Note:** The schema of the `result` nested field is the same as the response body schema of either the [\"Create an order\"](https://developer.zuora.com/api-references/api/operation/POST_Order) or the [\"Preview an order\"](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation, depending on the purpose of the job.\n\nThe following schema for the nested `result` field is defined as the response body schema of \"Create an order\". See [Preview an Order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) for the response body schema of \"Preview an order\". \n"
}
JournalEntryItemObjectCustomFields
{
"type": "object",
"title": "journalEntryItemFieldsCustom",
"description": "Container for custom fields of a Journal Entry Item object.\n",
"additionalProperties": {
"description": "Custom fields of the Journal Entry Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
JournalEntryObjectCustomFields
{
"type": "object",
"title": "journalEntryFieldsCustom",
"description": "Container for custom fields of a Journal Entry object.\n",
"additionalProperties": {
"description": "Custom fields of the Journal Entry object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
JsonNode
{
"type": "object",
"title": "JsonNode",
"description": "Json node object contains metadata."
}
LastTerm
{
"type": "object",
"required": [
"termType"
],
"properties": {
"period": {
"type": "integer",
"minimum": 0,
"description": "Specify only when the termType is 'TERMED'."
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date of the current term, in YYYY-MM-DD format.\n"
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN"
],
"type": "string"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the current term. You can change the term start date of a renewed subscription through a T&Cs order action. However, when changing it to an earlier date, this date must not be earlier than the term start date of the current term before this T&Cs.\n"
},
"periodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"description": "Specify only when the termType is 'TERMED'."
}
},
"description": "The length of the period for the current subscription term."
}
Linkage
{
"type": "object",
"properties": {
"linkage_type": {
"enum": [
"Start",
"Success",
"Failure",
"Iterate",
"True",
"False",
"Approve",
"Reject"
],
"type": "string"
},
"source_task_id": {
"type": "integer",
"description": "the task that spawned the target task"
},
"target_task_id": {
"type": "integer",
"description": "the task that the source task is linked to."
},
"source_workflow_id": {
"type": "integer",
"description": "the workflow the target task is associated with"
}
},
"description": "Used to represent the relationship between workflow tasks"
}
LinkedPaymentID
{
"type": "object",
"title": "PaymentID",
"properties": {
"paymentId": {
"type": "string",
"description": "ID of the payment.\n"
}
}
}
ListAllCatalogGroupsResponse
{
"type": "object",
"properties": {
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"catalogGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CatalogGroupResponse"
},
"description": "The list of catalog groups that are retrieved..\n"
}
}
}
ListAllSettingsResponse
{
"type": "object",
"title": "allSettings",
"properties": {
"settings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SettingItemWithOperationsInformation"
}
}
}
}
ListEInvoiceFileTemplatesResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"templates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetEInvoiceFileTemplateResponse"
},
"description": "Container for e-invoice file emplates.\n"
}
}
}
ListEInvoicingBusinessRegionsResponse
{
"type": "object",
"properties": {
"regions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetEInvoicingBusinessRegionResponse"
},
"description": "Container for e-invoicing business regions.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
}
}
}
ListEInvoicingServiceProvidersResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"serviceProviders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetEInvoicingServiceProviderResponse"
},
"description": "Container for e-invoicing service providers.\n"
}
}
}
MetadataCompareDeployProductCatalogRequest
{
"type": "object",
"required": [
"activeProducts",
"activeRatePlans",
"compareField",
"description",
"inActiveProducts",
"inActiveRatePlans",
"name",
"sendEmail",
"sourceTenantId"
],
"properties": {
"name": {
"type": "string",
"example": "Tenant01PC",
"description": "Deployment's name."
},
"emails": {
"type": "string",
"example": "zuoraUser@zuora.com",
"description": "If sendEmail parameter is set to true, comma separated values of emails can be specified. Example email1@test.com,email2@test.com."
},
"comments": {
"type": "string",
"example": "Product Catalog tenant - 47",
"description": "Content of the email to be sent."
},
"sendEmail": {
"type": "boolean",
"example": true,
"description": "Specifies if an email should be sent."
},
"description": {
"type": "string",
"example": "Product Catalog tenant - 01",
"description": "Deployment's description."
},
"compareField": {
"enum": [
"name",
"sku"
],
"type": "string",
"example": "name",
"description": "Specifies the compare field to be using during migration."
},
"activeProducts": {
"type": "boolean",
"example": true,
"description": "Specifies if active products needs to be migrated."
},
"sourceTenantId": {
"type": "string",
"example": "83e7e56d-0e02-4b4d-91f6-cc77f322c40b",
"description": "Specifies the source tenant id."
},
"activeRatePlans": {
"type": "boolean",
"example": true,
"description": "Specifies if active rate plans needs to be migrated."
},
"inActiveProducts": {
"type": "boolean",
"example": false,
"description": "Specifies if inactive products needs to be migrated."
},
"inActiveRatePlans": {
"type": "boolean",
"example": true,
"description": "Specifies if inactive active rate plans needs to be migrated."
}
}
}
MetadataCompareDeployProductCatalogResponse
{
"type": "object",
"example": {
"errorCode": "BAD_REQUEST",
"errorMessage": "Dependent module customFields is not included"
},
"properties": {
"errorCode": {
"type": "string",
"example": "BAD_REQUEST"
},
"errorMessage": {
"type": "string",
"example": "Dependent module customFields is not included"
}
}
}
MetadataCompareDeployTenantTemplateRequest
{
"type": "object",
"required": [
"description",
"name",
"sendEmail",
"template"
],
"properties": {
"name": {
"type": "string",
"description": "Deployment's name"
},
"emails": {
"type": "string",
"description": "If sendEmail parameter is set to true, comma separated values of emails can be specified. Example email1@test.com,email2@test.com."
},
"comments": {
"type": "string",
"description": "Content of the email to be sent."
},
"template": {
"type": "string",
"format": "binary",
"description": "Template file."
},
"sendEmail": {
"type": "boolean",
"description": "Specifies if an email should be sent."
},
"description": {
"type": "string",
"description": "Deployment's description."
}
}
}
MetadataCompareDeployTenantToTargetRequest
{
"type": "object",
"required": [
"customFields",
"description",
"name",
"notifications",
"productCatalog",
"reporting",
"sendEmail",
"settings",
"sourceTenantId",
"userRoles",
"workflows"
],
"properties": {
"name": {
"type": "string",
"description": "Deployment's name."
},
"emails": {
"type": "string",
"description": "If sendEmail parameter is set to true, comma separated values of emails can be specified. Example email1@test.com,email2@test.com."
},
"comments": {
"type": "string",
"description": "Content of the email to be sent."
},
"settings": {
"type": "boolean",
"description": "Specified if settings module should be considered in the deployment process."
},
"taxation": {
"type": "boolean",
"description": "Specified if taxation module should be considered in the deployment process."
},
"reporting": {
"type": "boolean",
"description": "Specified if reporting module should be considered in the deployment process."
},
"sendEmail": {
"type": "boolean",
"description": "Specifies if an email should be sent."
},
"userRoles": {
"type": "boolean",
"description": "Specified if userRoles module should be considered in the deployment process."
},
"workflows": {
"type": "boolean",
"description": "Specified if workflows module should be considered in the deployment process."
},
"description": {
"type": "string",
"description": "Deployment's description."
},
"customFields": {
"type": "boolean",
"description": "Specified if customFields module should be considered in the deployment process."
},
"customObjects": {
"type": "boolean",
"description": "Specified if customObjects module should be considered in the deployment process."
},
"notifications": {
"type": "boolean",
"description": "Specified if notifications module should be considered in the deployment process."
},
"productCatalog": {
"type": "boolean",
"description": "Specified if productCatalog module should be considered in the deployment process."
},
"sourceTenantId": {
"type": "string",
"description": "Id of the source tenant."
}
}
}
MetadataCompareDeployTenantToTargetResponse
{
"type": "object",
"example": {
"errorCode": "BAD_REQUEST",
"errorMessage": "Dependent module customFields is not included"
},
"properties": {
"errorCode": {
"type": "string",
"example": "BAD_REQUEST"
},
"errorMessage": {
"type": "string",
"example": "Dependent module customFields is not included"
}
}
}
MetadataDeployTenantTemplateRequest
{
"type": "object",
"required": [
"activeProducts",
"activeRatePlans",
"compareField",
"description",
"inActiveProducts",
"inActiveRatePlans",
"name",
"sendEmail",
"template"
],
"properties": {
"name": {
"type": "string",
"example": "Deploy PC",
"description": "Deployment's name."
},
"emails": {
"type": "string",
"example": "zuoraUser1@zuora.com,zuoraUser2@zuora.com",
"description": "If sendEmail parameter is set to true, comma separated values of emails can be specified."
},
"comments": {
"type": "string",
"example": "Import Product Catalog - template",
"description": "Content of the email to be sent."
},
"template": {
"type": "string",
"format": "binary",
"example": "@/Users/praghav/Downloads/products.json",
"description": "Template file."
},
"sendEmail": {
"type": "boolean",
"example": true,
"description": "Specifies if an email should be sent."
},
"description": {
"type": "string",
"example": "Import Product Catalog - template",
"description": "Deployment's description."
},
"compareField": {
"enum": [
"name",
"sku"
],
"type": "string",
"example": "name",
"description": "Specifies the compare field to be using during migration."
},
"activeProducts": {
"type": "boolean",
"example": true,
"description": "Specifies if active products needs to be migrated."
},
"activeRatePlans": {
"type": "boolean",
"example": true,
"description": "Specifies if active rate plans needs to be migrated."
},
"inActiveProducts": {
"type": "boolean",
"example": false,
"description": "Specifies if inactive products needs to be migrated."
},
"inActiveRatePlans": {
"type": "boolean",
"example": true,
"description": "Specifies if inactive rate plans needs to be migrated."
}
}
}
MetadataGetDeploymentLogResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the migration process."
},
"name": {
"type": "string",
"description": "Name of the migration."
},
"runBy": {
"type": "string",
"description": "Name of the user who executed the migration."
},
"failed": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key to identify a particular migration data."
},
"component": {
"type": "string",
"description": "Component name."
},
"errorInfo": {
"type": "string",
"description": "Error details of the migration."
},
"subComponent": {
"type": "string",
"description": "Subcomponent name."
}
}
}
},
"status": {
"type": "string",
"description": "Migration status."
},
"skipped": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key to identify a particular migration data."
},
"reason": {
"type": "string",
"description": "The rationale behind the non-migration of specific data."
},
"component": {
"type": "string",
"description": "Component name."
},
"subComponent": {
"type": "string",
"description": "Subcomponent name."
}
}
}
},
"succeeded": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key to identify a particular migration data."
},
"component": {
"type": "string",
"description": "Component name."
},
"subComponent": {
"type": "string",
"description": "Subcomponent name."
}
}
}
},
"description": {
"type": "string",
"description": "Description of the migration."
},
"targetTenant": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Target tenant id."
},
"name": {
"type": "string",
"description": "Target tenant name."
},
"environment": {
"type": "string",
"description": "Target tenant description."
}
}
},
"deploymentDate": {
"type": "string",
"description": "Deployment timestamp."
}
}
}
MetadataRevertDeploymentResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the Deployment Manager migration process."
},
"name": {
"type": "string",
"description": "Name of the Deployment Manager migration process."
},
"type": {
"type": "string",
"description": "Type of the Deployment Manager migration process."
},
"errors": {
"type": "string",
"description": "Errors of the Deployment Manager migration process."
},
"status": {
"enum": [
"DEPLOYING",
"REVERTING",
"PARTIALLY-REVERTED",
"FAILED",
"ROLLBACK-FAILED",
"REVERTED",
"COMPARING",
"SUBMITTED",
"SKIPPED",
"IDENTICAL",
"COMPARE-DONE",
"COMPARE-FAILED",
"CANCELLED"
],
"type": "string",
"description": "Status of the Deployment Manager migration process."
},
"endTime": {
"type": "string",
"description": "end timestamp of the Deployment Manager migration process."
},
"emailIds": {
"type": "string",
"description": "emailIds notified of the Deployment Manager migration process."
},
"startTime": {
"type": "string",
"description": "start timestamp of the Deployment Manager migration process."
},
"migratedBy": {
"type": "string",
"description": "User who initiated the Deployment Manager migration process."
},
"description": {
"type": "string",
"description": "Description of the Deployment Manager migration process."
},
"environment": {
"type": "string",
"description": "Environment of the Deployment Manager migration process."
},
"productCatalog": {
"type": "boolean",
"description": "Boolean flag specifies if the migration process includes product catalog module."
},
"sourceTenantName": {
"type": "string",
"description": "Name of the source Tenant."
},
"sourceTenantDescription": {
"type": "string",
"description": "Description of the source Tenant."
}
}
}
MigrationClientResponse
{
"type": "object",
"title": "MigrationClientResponse",
"required": [
"id",
"migratedBy",
"migrationDescription",
"migrationEnd",
"migrationName",
"migrationStart",
"sourceTenantDescription",
"sourceTenantName",
"status"
],
"properties": {
"id": {
"type": "string",
"description": "Variable to hold the job ID."
},
"type": {
"type": "string"
},
"status": {
"type": "string",
"example": "IN PROGRESS",
"description": "Status of the Migration Job."
},
"emailIds": {
"type": "string",
"description": "List of Emails with comma separator "
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MigrationComponentContent"
}
},
"migratedBy": {
"type": "string",
"example": "Jane Cooper",
"description": "User responsible for migration."
},
"environment": {
"type": "string",
"description": "Environment information"
},
"migrationEnd": {
"type": "string",
"example": "2020-11-01 18:00:00",
"description": "Timestamp when migration ended."
},
"migrationName": {
"type": "string",
"example": "Job A",
"description": "Name of the migration."
},
"migrationStart": {
"type": "string",
"example": "2020-11-01 18:00:00",
"description": "Timestamp when migration started."
},
"sourceTenantName": {
"type": "string",
"example": "Duno",
"description": "Source Tenant Name."
},
"migrationDescription": {
"type": "string",
"example": "Migration from/to Sandbox",
"description": "Description of the migration."
},
"sourceTenantDescription": {
"type": "string",
"example": "Duno",
"description": "Source Tenant Description."
}
},
"description": "Response after migration is added."
}
MigrationComponentContent
{
"type": "object",
"title": "MigrationComponentContent",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"result": {
"type": "string",
"description": "Returns the result details of Components."
},
"status": {
"type": "string",
"description": "Returns the status of each component."
},
"disabled": {
"type": "string"
},
"attribute": {
"type": "string"
},
"migratedOn": {
"type": "string",
"format": "date-time",
"description": "It is the time when migration is triggered."
},
"description": {
"type": "string"
},
"httpMethods": {
"type": "string"
},
"migrationId": {
"type": "string",
"description": "Migration ID. It is generated at the time of triggering deployment."
},
"pathPattern": {
"type": "string",
"description": "PathPattern of component."
},
"errorMessage": {
"type": "string",
"description": "Error information."
},
"updateStatus": {
"type": "string",
"description": "Updated Status."
},
"componentType": {
"type": "string",
"description": "Type of selected components to be migrated."
},
"segregationKey": {
"type": "string",
"description": "Displays the differences between components."
},
"sourceResponse": {
"$ref": "#/components/schemas/JsonNode"
},
"currentTargetResponse": {
"$ref": "#/components/schemas/JsonNode"
},
"previousTargetResponse": {
"$ref": "#/components/schemas/JsonNode"
}
},
"description": "When a comparison is made between a source and target tenant, it sends a response to the user interface."
}
MigrationUpdateCustomObjectDefinitionsRequest
{
"type": "object",
"required": [
"actions"
],
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomObjectDefinitionUpdateActionRequest"
},
"maxItems": 1,
"minItems": 1,
"description": "The actions of updating custom object definitions, to be performed as parts of the migration. Currently only one action per migration is supported."
}
}
}
MigrationUpdateCustomObjectDefinitionsResponse
{
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomObjectDefinitionUpdateActionResponse"
},
"maxItems": 1,
"minItems": 1,
"description": "The actions of updating custom object definitions, to be performed as parts of the migration. Currently only one action per migration is supported."
}
}
}
ModifiedStoredCredentialProfileResponse
{
"type": "object",
"properties": {
"number": {
"type": "integer",
"description": "The number that identifies the stored credential profile within the payment method.\n"
},
"success": {
"type": "boolean"
},
"paymentMethodId": {
"type": "string",
"description": "ID of the payment method.\n"
}
}
}
NestedAccountOnExpand
{
"type": "object",
"title": "QueryAccountResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the account.\n"
},
"mrr": {
"type": "number",
"description": "Monthly recurring revenue for the account.\n"
},
"name": {
"type": "string",
"description": "The name of the account.\n"
},
"batch": {
"type": "string",
"description": "The alias name given to a batch. A string of 50 characters or less.\n"
},
"crmId": {
"type": "string",
"maxLength": 100,
"description": "External identifier of the account in a CRM system.\n"
},
"notes": {
"type": "string",
"description": "A string of up to 65,535 characters.\n"
},
"vATId": {
"type": "string",
"description": "EU Value Added Tax ID."
},
"billTo": {
"type": "object",
"description": "EXPANDABLE.\nThe bill-to contact on this account.\n"
},
"soldTo": {
"type": "object",
"description": "EXPANDABLE.\nThe sold-to contact on the account.\n"
},
"status": {
"enum": [
"Active",
"Draft",
"Canceled"
],
"type": "string",
"description": "The account status.\n"
},
"usages": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe usage records associated with the account. \n"
},
"autoPay": {
"type": "boolean",
"description": "Indicates whether future payments are automatically collected when they are due\nduring a payment run.\n"
},
"balance": {
"type": "number",
"format": "double",
"description": "The customer's total invoice balance minus credit balance.\n"
},
"refunds": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe refunds associated with the account. \n"
},
"billToId": {
"type": "string",
"description": "The unique identifier of the bill-to contact associated with the account.\n"
},
"currency": {
"type": "string",
"description": "A currency defined in the web-based UI administrative settings.\n"
},
"invoices": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe invoices associated with the account. \n"
},
"parentId": {
"type": "string",
"description": "Identifier of the parent customer account for this Account object. The\nlength is 32 characters. Use this field if you have <a\nhref=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\"\ntarget=\"_blank\">Customer Hierarchy</a> enabled.\n"
},
"payments": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe payments associated with the account. \n"
},
"soldToId": {
"type": "string",
"description": "The unique identifier of the sold-to contact associated with the account.\n"
},
"debitMemos": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe debit memos associated with the account. \n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the account.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the account was created.\n"
},
"creditMemos": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe credit memos associated with the account. \n"
},
"paymentTerm": {
"type": "string",
"description": "A payment-terms indicator defined in the web-based UI administrative\nsettings, for example, `Net 30`.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the account.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the account was last updated.\n"
},
"billCycleDay": {
"type": "integer",
"format": "int64",
"description": "Billing cycle day (BCD), the day of the month when a bill run\ngenerates invoices for the account.\n"
},
"salesRepName": {
"type": "string",
"description": "Name of the account's sales representative, if applicable.\n"
},
"accountNumber": {
"type": "string",
"description": "The account number that identifies the account.\n"
},
"creditBalance": {
"type": "number",
"format": "double",
"description": "The current credit balance on the account.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the billing document sequence set to assign to the customer account. \nThe billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.\nIf a customer account has no assigned billing document sequence set, billing documents generated for this account adopt the prefix and starting document number from the default sequence set.\n"
},
"subscriptions": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe subscriptions associated with the account.\n"
},
"organizationId": {
"type": "string",
"description": "The unique identifier of the organization to which the account belongs.\n"
},
"partnerAccount": {
"type": "boolean",
"description": "Whether the customer account is a partner, distributor, or reseller. \n\n**Note**: This field is available only if you have the <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account\"\ntarget=\"_blank\">Reseller Account</a> feature enabled.\n"
},
"paymentGateway": {
"type": "string",
"description": "The name of the payment gateway instance. If null or left unassigned,\nthe account will use the default gateway.\n"
},
"paymentMethods": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe payment methods associated with the account.\n"
},
"taxCompanyCode": {
"type": "string",
"maxLength": 50,
"description": "Unique code that identifies a company account in Avalara. \n**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com).\n"
},
"lastInvoiceDate": {
"type": "string",
"format": "date",
"description": "Date of the most recent invoice for the account; null if no invoice has ever been generated.\n"
},
"taxExemptStatus": {
"enum": [
"No",
"Yes",
"PendingVerification"
],
"type": "string",
"default": "No",
"description": "Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax. \n"
},
"allowInvoiceEdit": {
"type": "boolean",
"default": false,
"description": "Indicates whether associated invoices can be edited.\n"
},
"bcdSettingOption": {
"enum": [
"ManualSet",
"AutoSet"
],
"type": "string",
"description": "The billing cycle day setting option for the account.\n"
},
"unappliedBalance": {
"type": "number",
"description": "Total unapplied balance in this currency.\n"
},
"eInvoiceProfileId": {
"type": "string",
"description": "ID of the e-invoice profile for this account.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "Invoice template ID, configured in Billing Settings in the Zuora UI.\n"
},
"lastMetricsUpdate": {
"type": "string",
"format": "date-time",
"description": "The date and time when account metrics are last updated, if the account is a partner account.\n\n**Note**: \n- This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account\" target=\"_blank\">Reseller Account</a> feature enabled.\n- If you ever set the `partnerAccount` field to `true` for an account, the value of `lastMetricsUpdate` field is the time when the account metrics are last updated.\n"
},
"debitMemoTemplateId": {
"type": "string",
"description": "ID of the debit memo template that is used to generate debit memos for the account.\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "The purchase order number provided by your customer for services,\nproducts, or both purchased.\n"
},
"totalInvoiceBalance": {
"type": "number",
"format": "double",
"description": "Total balance of all posted invoices.\n"
},
"creditMemoTemplateId": {
"type": "string",
"description": "ID of the credit memo template that is used to generate credit memos for the account.\n"
},
"defaultPaymentMethod": {
"type": "object",
"description": "EXPANDABLE.\nThe default payment method associated with the account.\n"
},
"taxExemptDescription": {
"type": "string",
"maxLength": 500,
"description": "Description of the tax exemption certificate that the customer holds.\nApplicable if you use Zuora Tax or Connect tax engines.\n"
},
"totalDebitMemoBalance": {
"type": "number",
"format": "double",
"description": "Total balance of all posted debit memos.\n"
},
"communicationProfileId": {
"type": "string",
"description": "The unique identifier of the communication profile that Zuora uses when sending notifications to the account's contacts.\n"
},
"customerServiceRepName": {
"type": "string",
"maxLength": 50,
"description": "Name of the account's customer service representative, if applicable.\n"
},
"defaultPaymentMethodId": {
"type": "string",
"description": "ID of the default payment method for the account.\n"
},
"taxExemptCertificateID": {
"type": "string",
"maxLength": 32,
"description": "ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"taxExemptEffectiveDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption starts, in `YYYY-MM-DD` format. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"taxExemptEntityUseCode": {
"type": "string",
"maxLength": 64,
"description": "A unique entity use code to apply exemptions in Avalara AvaTax. See <a href=\"https://developer.avalara.com/avatax/handling-tax-exempt-customers/\" target=\"_blank\">Exempt Transactions</a> for more details.\n"
},
"taxExemptExpirationDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption expires, in `YYYY-MM-DD` format. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"additionalEmailAddresses": {
"type": "string",
"description": "An additional email addresse to receive email notifications.\n"
},
"taxExemptCertificateType": {
"type": "string",
"maxLength": 32,
"description": "Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"invoiceDeliveryPrefsEmail": {
"type": "boolean",
"description": "Indicates whether the customer wants to receive invoices through email. \n"
},
"invoiceDeliveryPrefsPrint": {
"type": "boolean",
"description": "Whether the customer wants to receive printed invoices, such as through postal mail.\n"
},
"unappliedCreditMemoAmount": {
"type": "number",
"format": "double",
"description": "The total unapplied amount of all posted credit memos in this currency.\n"
},
"taxExemptIssuingJurisdiction": {
"type": "string",
"maxLength": 32,
"description": "Jurisdiction in which the customer tax exemption certificate was issued.\n"
}
}
}
NestedCreditMemoApplicationOnExpand
{
"type": "object",
"title": "QueryCreditMemoApplicationResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the credit memo application.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The application amount of the credit memo.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the credit memo.\n"
},
"invoiceId": {
"type": "string",
"description": "The ID of the invoice to which the credit memo is applied.\n"
},
"creditMemo": {
"type": "object",
"description": "EXPANDABLE.\nThe credit memo associated with the credit memo application.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the credit memo application.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo application was created.\n"
},
"debitMemoId": {
"type": "string",
"description": "The ID of the debit memo to which the credit memo is applied.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the credit memo application.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo application was last updated.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo associated with the credit memo application.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the credit memo application becomes effective.\n"
},
"applicationGroupId": {
"type": "string",
"description": "The ID of the application group to which this credit memo application belongs.\n"
}
}
}
NestedCreditMemoItemOnExpand
{
"type": "object",
"title": "QueryCreditMemoItemResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the credit memo item.\n"
},
"sku": {
"type": "string",
"description": "The SKU for the product associated with the credit memo item.\n"
},
"amount": {
"type": "number",
"description": "The amount of the credit memo item. For tax-inclusive credit memo\nitems, the amount indicates the credit memo item amount including tax.\nFor tax-exclusive credit memo items, the amount indicates the credit\nmemo item amount excluding tax.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive"
],
"type": "string",
"description": "The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax.\n"
},
"itemType": {
"type": "string",
"description": "The type of the credit memo item.\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "The number of units for the credit memo item.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of the tax applied to the credit memo item.\n"
},
"unitPrice": {
"type": "number",
"format": "double",
"description": "The per-unit price of the credit memo item.\n"
},
"chargeDate": {
"type": "string",
"format": "date-time",
"description": "The date when the credit memo item is charged, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"chargeName": {
"type": "string",
"description": "The name of the charge associated with the credit memo item. \n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the credit memo item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo item was created.\n"
},
"description": {
"type": "string",
"description": "The description of the credit memo item.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `257.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"taxCodeName": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific credit memo item.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the credit memo item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo item was last updated.\n"
},
"chargeNumber": {
"type": "string",
"description": "The number of the product rate plan charge that the credit memo is created from.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo to which this credit memo item belongs.\n"
},
"subscription": {
"type": "object",
"description": "The subscription associated with the credit memo item.\n"
},
"fulfillmentId": {
"type": "string",
"description": "The reference ID of the fulfillment associated with the credit memo item.\n"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the invoice item associated with the credit memo item.\n"
},
"unitOfMeasure": {
"type": "string",
"description": "The units to measure usage.\n"
},
"journalEntryId": {
"type": "string",
"description": "The ID of the journal entry that corresponds to this transaction.\n"
},
"processingType": {
"enum": [
"Charge",
"Discount"
],
"type": "string",
"description": "The type of the charge for the credit memo item. \n"
},
"ratePlanCharge": {
"type": "object",
"description": "The rate plan charge associated with the credit memo item.\n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The service end date of the credit memo item. \n"
},
"sourceItemType": {
"enum": [
"SubscriptionComponent",
"InvoiceDetail",
"ProductRatePlanCharge",
"OrderLineItem"
],
"type": "string",
"description": "The type of the source item.\n\n- If a credit memo is not created from an invoice or a product rate plan charge or a return order line item, the value of this field is `SubscriptionComponent`. \n- If a credit memo is created from an invoice, the value of this field is `InvoiceDetail`.\n- If a credit memo is created from a product rate plan charge, the value of this field is `ProductRatePlanCharge`.\n- If a credit memo is created from a return order line item, the value of this field is `OrderLineItem`.\n \n"
},
"subscriptionId": {
"type": "string",
"description": "The ID of the subscription associated with the credit memo item.\n"
},
"appliedToItemId": {
"type": "string",
"description": "The unique ID of the credit memo item that the discount charge is applied to.\n"
},
"orderLineItemId": {
"type": "string",
"description": "The ID of the order line item associated with the credit memo item, if applicable.\n"
},
"taxExemptAmount": {
"type": "number",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"unappliedAmount": {
"type": "number",
"format": "double",
"description": "The unapplied amount of the credit memo item.\n"
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "The credit memo item amount excluding tax.\n"
},
"creditFromItemId": {
"type": "string",
"description": "The ID of the credit from item.\n"
},
"ratePlanChargeId": {
"type": "string",
"description": "The ID of the rate plan charge associated with the credit memo item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The service start date of the credit memo item.\n"
},
"invoiceScheduleId": {
"type": "string",
"description": "The ID of the invoice schedule associated with the credit memo item. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"numberOfDeliveries": {
"type": "number",
"description": "The number of deliveries dedicated to the Delivery Pricing charges. The value might be different, as follows:\n- For the credit memo generated by a bill run, this field has a value. \n- For the credit memo generated from an invoice, this field is blank.\n**Note**: This field is available only if you have the Delivery Pricing feature enabled.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "The number of the subscription associated with the credit memo item.\n"
},
"itemSoldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the credit memo item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "The purchase order number associated the credit memo item.\n"
},
"creditFromItemSource": {
"enum": [
"InvoiceItem",
"CreditMemoItem"
],
"type": "string",
"description": "The type of the credit from item.\n"
},
"appliedToOthersAmount": {
"type": "number",
"description": "The amount of the credit memo that is applied to other credit memo\nitems.\n"
},
"invoiceScheduleItemId": {
"type": "string",
"description": "The ID of the invoice schedule item associated with the credit memo item. The credit memo item is generated during the processing of the invoice schedule item.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"commitmentChargeNumber": {
"type": "string"
},
"beAppliedByOthersAmount": {
"type": "number"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot associated with the credit memo.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of the product rate plan charge that the credit memo is created\nfrom.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the credit memo.\n"
},
"onAccountAccountingCodeId": {
"type": "string",
"description": "The On Account accounting code for the credit memo item.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"itemSoldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the credit memo item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"commitmentChargeSegmentNumber": {
"type": "string"
},
"deferredRevenueAccountingCodeId": {
"type": "string",
"description": "The Deferred Revenue accounting code for the credit memo item.\n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "The Account Receivable accounting code for the credit memo item.\n"
},
"recognizedRevenueAccountingCodeId": {
"type": "string",
"description": "The Recognized Revenue accounting code for the credit memo item.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the credit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
}
NestedCreditMemoOnExpand
{
"type": "object",
"title": "QueryCreditMemoResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the credit memo.\n"
},
"source": {
"enum": [
"BillRun",
"API",
"ApiSubscribe",
"ApiAmend",
"AdhocFromPrpc",
"AdhocFromInvoice"
],
"type": "string",
"description": "The source of the credit memo.\n\nPossible values:\n- `BillRun`: The credit memo is generated by a bill run.\n- `API`: The credit memo is created by calling the [Invoice and collect](https://developer.zuora.com/api-references/api/operation/POST_TransactionInvoicePayment) operation, or by calling the Orders, Order Line Items, or Fulfillments API operations.\n- `ApiSubscribe`: The credit memo is created by calling the [Create subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription) and [Create account](https://developer.zuora.com/api-references/api/operation/POST_Account) operation.\n- `ApiAmend`: The credit memo is created by calling the [Update subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription) operation.\n- `AdhocFromPrpc`: The credit memo is created from a product rate plan charge through the Zuora UI or by calling the [Create a credit memo from a charge](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc) operation.\n- `AdhocFromInvoice`: The credit memo is created from an invoice or created by reversing an invoice. You can create a credit memo from an invoice through the Zuora UI or by calling the [Create credit memo from invoice](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice) operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the [Reverse invoice](https://developer.zuora.com/api-references/api/operation/PUT_ReverseInvoice) operation.\n"
},
"status": {
"enum": [
"Draft",
"Posted",
"Canceled",
"Error",
"PendingForTax",
"Generating",
"CancelInProgress"
],
"type": "string",
"description": "The status of the credit memo.\n"
},
"account": {
"type": "object",
"description": "EXPANDABLE.\nThe account associated with the credit memo.\n"
},
"balance": {
"type": "number",
"description": "The remaining balance of credit memo.\n"
},
"comment": {
"type": "string",
"description": "Comments about the credit memo.\n"
},
"currency": {
"type": "string",
"nullable": true,
"description": "The currency of the credit memo.\n\n**Note:** By default, the currency on a billing document matches the default currency set on the associated account. \nHowever, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. \nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currency</a>.\n"
},
"memoDate": {
"type": "string",
"format": "date",
"description": "The date when the credit memo takes effect, in `yyyy-mm-dd` format.\nFor example, `2024-01-01`.\n"
},
"postedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was posted, in\n`yyyy-mm-dd hh:mm:ss` format.\n"
},
"reversed": {
"type": "boolean",
"description": "Whether the credit memo is reversed.\n"
},
"sourceId": {
"type": "string",
"description": "The ID of the credit memo source.\n\nIf a credit memo is generated from a bill run, the value is the\nnumber of the corresponding bill run. Otherwise, the value is\n`null`.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the credit memo.\n"
},
"invoiceId": {
"type": "string",
"description": "The ID of a referred invoice.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of taxation.\n"
},
"taxStatus": {
"enum": [
"Complete",
"Error"
],
"type": "string",
"description": "The status of tax calculation related to the credit memo.\n\n**Note**: This field is only applicable to tax calculation by third-party tax engines.\n"
},
"memoNumber": {
"type": "string",
"description": "The unique identification number of the credit memo.\n"
},
"postedById": {
"type": "string",
"description": "The ID of the Zuora user who posted the credit memo.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value\nmust be an existing reason code or empty.\n"
},
"sourceType": {
"enum": [
"Subscription",
"Standalone",
"Invoice",
"Order",
"CreditMemo",
"Consolidation"
],
"type": "string",
"description": "The type of the credit memo source.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for the credit memo, in `yyyy-mm-dd` format. For example, `2024-01-01`.\n"
},
"taxMessage": {
"type": "string",
"description": "The message about the status of tax calculation related to the credit memo. If tax calculation fails in one credit memo, this field displays the reason for the failure.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the credit memo.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was created.\n"
},
"totalAmount": {
"type": "number",
"format": "double",
"description": "The total amount of the credit memo, including taxes.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the credit memo.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the credit memo was last updated.\n"
},
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the refund on the credit memo.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the credit memo.\n"
},
"billToContact": {
"type": "object",
"description": "EXPANDABLE.\nThe bill-to contact on the account.\n"
},
"cancelledById": {
"type": "string",
"description": "The ID of the Zuora user who cancelled the credit memo.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the credit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"discountAmount": {
"type": "number",
"description": "The amount of the discount on the credit memo.\n"
},
"einvoiceFileId": {
"type": "string",
"description": "The ID of the e-invoice file generated for the credit memo.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"einvoiceStatus": {
"enum": [
"Processing",
"Generated",
"Success",
"Failed"
],
"type": "string",
"description": "The status of the e-invoice file generation for the credit memo. \n\n- If e-invoice file generation succeeds, this field is either `Generated` or `Success`, and both the error code and message are empty, and the `eInvoiceFileId` field stores the ID of the generated e-invoice file.\n- If a failure occurs during e-invoice file generation, this field is `Failed` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the credit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"creditMemoItems": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe credit memo items on the current credit memo.\n"
},
"exchangeRateDate": {
"type": "string",
"format": "date",
"description": "The date of the exchange rate used. The date is in `yyyy-mm-dd` format.\nCorresponds to the value specified in the Provider Exchange Rate Date column in the Import Foreign Exchange Rates template when you uploaded the rates through the Mass Updater.\n"
},
"einvoiceErrorCode": {
"type": "string",
"description": "The error code returned when the e-invoice file status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"taxAutoCalculation": {
"type": "boolean",
"default": true,
"description": "Whether to automatically calculate taxes in the credit memo.\n"
},
"autoApplyUponPosting": {
"type": "boolean",
"description": "Whether the credit memo automatically applies to the invoice upon\nposting.\n"
},
"einvoiceErrorMessage": {
"type": "string",
"description": "The error message returned when the e-invoice file status is `Failed`. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"totalTaxExemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"totalAmountWithoutTax": {
"type": "number",
"format": "double",
"description": "The total amount of the credit memo, excluding taxes.\n"
},
"creditMemoApplications": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe credit memo applications associated with the current credit memo.\n"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot associated with the credit memo.\n\nThe value of this field is `null` if the bill rule [Preserve snapshot of bill-to and sold-to contacts when billing documents are posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted) is disabled.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the\ncredit memo.\n\n**Note**: If you have the Flexible Billing Attributes feature\ndisabled, the value of this field is `null`.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the credit memo was transferred to an external\naccounting system. This field is used for integration with\naccounting systems such as NetSuite.\n"
},
"excludeFromAutoApplyRules": {
"type": "boolean",
"description": "Whether the credit memo is excluded from the rule of automatically applying credit memos to invoices.\n"
}
}
}
NestedDebitMemoItemOnExpand
{
"type": "object",
"title": "QueryDebitMemoItemResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the debit memo item.\n"
},
"sku": {
"type": "string",
"description": "The SKU for the product associated with the debit memo item.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax.\n"
},
"balance": {
"type": "number",
"format": "double",
"description": "The balance of the debit memo item.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive"
],
"type": "string",
"description": "The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax.\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "The number of units for the debit memo item.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of tax on this debit memo.\n"
},
"unitPrice": {
"type": "number",
"format": "double",
"description": "The per-unit price of the debit memo item.\n"
},
"chargeDate": {
"type": "string",
"format": "date-time",
"description": "The date when the debit memo item is charged, in `yyyy-mm-dd hh:mm:ss`\nformat.\n"
},
"chargeName": {
"type": "string",
"description": "The name of the charge associated with the debit memo item.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the debit memo item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo item was created.\n"
},
"debitMemoId": {
"type": "string",
"description": "The ID of the debit memo to which this debit memo item belongs.\n"
},
"description": {
"type": "string",
"description": "The description of the debit memo item.\n"
},
"taxCodeName": {
"type": "string",
"description": "Name of the tax code identifies which tax rules and tax rates to apply to a specific debit memo item.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the debit memo item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo item was last updated.\n"
},
"chargeNumber": {
"type": "string",
"description": "The number of the charge associated with the debit memo item.\n"
},
"subscription": {
"type": "object",
"description": "EXPANDABLE.\nThe subscription associated with the debit memo item.\n"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the invoice item associated with the debit memo item.\n"
},
"unitOfMeasure": {
"type": "string",
"description": "The units to measure usage.\n"
},
"journalEntryId": {
"type": "string",
"description": "The ID of the journal entry that corresponds to this transaction.\n"
},
"processingType": {
"enum": [
"Charge",
"Discount"
],
"type": "string",
"description": "The type of the charge for the debit memo item. \n"
},
"ratePlanCharge": {
"type": "object",
"description": "EXPANDABLE.\nThe rate plan charge associated with the debit memo item.\n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The end date of the service period associated with this debit memo item. Service ends one second before the date specified in this field.\n"
},
"sourceItemType": {
"enum": [
"CreditMemoItem",
"SubscriptionComponent",
"InvoiceDetail",
"ProductRatePlanCharge"
],
"type": "string",
"description": "The type of the source item.\n"
},
"subscriptionId": {
"type": "string",
"description": "The ID of the subscription associated with the debit memo item.\n"
},
"appliedToItemId": {
"type": "string",
"description": "The parent debit memo item that this debit memo items is applied to if this item is discount.\n"
},
"taxExemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "The debit memo item amount excluding tax.\n"
},
"creditMemoItemId": {
"type": "string"
},
"ratePlanChargeId": {
"type": "string",
"description": "The ID of the rate plan charge associated with the debit memo item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The start date of the service period associated with this debit memo item. If the associated charge is a one-time fee, this date is the date of that charge.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "The number of the subscription associated with the debit memo item.\n"
},
"itemSoldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the debit memo item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"appliedToOthersAmount": {
"type": "number"
},
"beAppliedByOthersAmount": {
"type": "number"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot associated with the credit memo.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of the product rate plan charge based on which the debit memo item is created.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the credit memo.\n"
},
"itemSoldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the debit memo item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"deferredRevenueAccountingCodeId": {
"type": "string",
"description": "The Deferred Revenue accounting code for the credit memo item.\n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "The Account Receivable accounting code for the credit memo item.\n"
},
"recognizedRevenueAccountingCodeId": {
"type": "string",
"description": "The Recognized Revenue accounting code for the credit memo item.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the debit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
}
NestedDebitMemoOnExpand
{
"type": "object",
"title": "QueryDebitMemoResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the debit memo.\n"
},
"source": {
"enum": [
"BillRun",
"API",
"ApiSubscribe",
"ApiAmend",
"AdhocFromPrpc",
"AdhocFromInvoice"
],
"type": "string",
"description": "The source of the debit memo.\nPossible values:\n- `BillRun`: The debit memo is generated by a bill run.\n- `API`\n- `ApiSubscribe`: The debit memo is created by calling the [Create subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription) and [Create account](https://developer.zuora.com/api-references/api/operation/POST_Account) operation.\n- `ApiAmend`: The debit memo is created by calling the [Update subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription) operation.\n- `AdhocFromPrpc`: The debit memo is created from a product rate plan charge through the Zuora UI or by calling the [Create a debit memo from a charge](https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromPrpc/) operation.\n- `AdhocFromInvoice`: The debit memo is created from an invoice or created by reversing an invoice. You can create a debit memo from an invoice through the Zuora UI or by calling the [Create a debit memo from an invoice](https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromInvoice/) operation.\n"
},
"status": {
"enum": [
"Draft",
"Posted",
"Canceled",
"Error",
"PendingForTax",
"Generating",
"CancelInProgress"
],
"type": "string",
"description": "The status of the debit memo.\n"
},
"account": {
"type": "object",
"description": "EXPANDABLE.\nThe account associated with the debit memo.\n"
},
"autoPay": {
"type": "boolean",
"description": "Whether debit memos are automatically picked up for processing in the\ncorresponding payment run.\n\n\nBy default, debit memos are automatically picked up for processing in\nthe corresponding payment run.\n"
},
"balance": {
"type": "number",
"description": "The remaining balance of debit memo.\n"
},
"dueDate": {
"type": "string",
"format": "date",
"description": "The date by which the payment for the debit memo is due, in\n`yyyy-mm-dd` format.\n"
},
"comments": {
"type": "string",
"description": "Comments about the debit memo.\n"
},
"currency": {
"type": "string",
"nullable": true,
"description": "The currency of the debit memo.\n\n**Note:** By default, the currency on a billing document matches the default currency set on the associated account. \nHowever, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. \nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currency</a>.\n"
},
"memoDate": {
"type": "string",
"format": "date",
"description": "The date when the debit memo takes effect, in `yyyy-mm-dd` format.\nFor example, `2024-01-01`.\n"
},
"postedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was posted, in\n`yyyy-mm-dd hh:mm:ss` format.\n"
},
"sourceId": {
"type": "string",
"description": "The ID of the debit memo source.\n\nIf a debit memo is generated from a bill run, the value is the\nnumber of the corresponding bill run. Otherwise, the value is\n`null`.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the debit memo.\n"
},
"invoiceId": {
"type": "string",
"description": "The ID of a referred invoice.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of taxation.\n"
},
"taxStatus": {
"enum": [
"Complete",
"Error"
],
"type": "string",
"description": "The status of tax calculation related to the debit memo.\n\n\n**Note**: This field is only applicable to tax calculation by\nthird-party tax engines.\n"
},
"memoNumber": {
"type": "string",
"description": "The unique identification number of the debit memo.\n"
},
"postedById": {
"type": "string",
"description": "The ID of the Zuora user who posted the debit memo.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value\nmust be an existing reason code or empty.\n"
},
"sourceType": {
"enum": [
"Subscription",
"Standalone",
"Order",
"Consolidation",
"Invoice",
"CreditMemo"
],
"type": "string",
"description": "The type of the debit memo source.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for the debit memo, in `yyyy-mm-dd` format. For example, `2024-01-01`.\n"
},
"taxMessage": {
"type": "string",
"description": "The message about the status of tax calculation related to the\ndebit memo. If tax calculation fails in one debit memo, this\nfield displays the reason for the failure.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the debit memo.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was created.\n"
},
"paymentTerm": {
"type": "string",
"description": "The name of the payment term assoicated with the debit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing\nAttributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes)\nfeature disabled.\n"
},
"totalAmount": {
"type": "number",
"format": "double",
"description": "The total amount of the debit memo, including taxes.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the debit memo.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the debit memo was last updated.\n"
},
"creditMemoId": {
"type": "string",
"nullable": true,
"description": "The ID of the credit memo from which the debit memo was created.\n"
},
"billToContact": {
"type": "object",
"description": "EXPANDABLE.\nThe bill-to contact associated with the debit memo.\n"
},
"cancelledById": {
"type": "string",
"description": "The ID of the Zuora user who cancelled the debit memo.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the debit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"debitMemoItems": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe debit memo items associated with the debit memo.\n"
},
"discountAmount": {
"type": "number",
"description": "The amount of the discount on the debit memo.\n"
},
"einvoiceFileId": {
"type": "string",
"description": "The ID of the e-invoice file generated for the debit memo.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"einvoiceStatus": {
"enum": [
"Processing",
"Generated",
"Success",
"Failed"
],
"type": "string",
"description": "The status of the e-invoice file generation for the credit memo. \n\n- If e-invoice file generation succeeds, this field is either `Generated` or `Success`, and both the error code and message are empty, and the `eInvoiceFileId` field stores the ID of the generated e-invoice file.\n- If a failure occurs during e-invoice file generation, this field is `Failed` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the debit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"exchangeRateDate": {
"type": "string",
"format": "date",
"description": "The date of the exchange rate used. The date is in `yyyy-mm-dd` format.\nCorresponds to the value specified in the Provider Exchange Rate Date column in the Import Foreign Exchange Rates template when you uploaded the rates through the Mass Updater.\n"
},
"einvoiceErrorCode": {
"type": "string",
"description": "The error code returned when the e-invoice file status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"taxAutoCalculation": {
"type": "boolean",
"default": true,
"description": "Whether to automatically calculate taxes in the debit memo.\n"
},
"einvoiceErrorMessage": {
"type": "string",
"description": "The error message returned when the e-invoice file status is `Failed`. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
},
"totalTaxExemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"totalAmountWithoutTax": {
"type": "number",
"format": "double",
"description": "The total amount of the debit memo, excluding taxes.\n"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot associated with the debit memo.\n\nThe value of this field is `null` if the bill rule [Preserve snapshot of bill-to and sold-to contacts when billing documents are posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted) is disabled.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the\ndebit memo.\n\n**Note**: If you have the Flexible Billing Attributes feature\ndisabled, the value of this field is `null`.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the debit memo was transferred to an external\naccounting system. This field is used for integration with\naccounting systems such as NetSuite.\n"
}
}
}
NestedInvoiceItemOnExpand
{
"type": "object",
"title": "QueryInvoiceItemResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the invoice item.\n"
},
"sKU": {
"type": "string",
"description": "The SKU of the product associated with the invoice item.\n"
},
"uOM": {
"type": "string",
"description": "The unit of measure (UOM) that is configured in **Settings > Billing** for the product rate plan charge.\n"
},
"balance": {
"type": "number",
"description": "The balance of the invoice item.\n\n**Note**: This field is only available if you have the Invoice Settlement feature enabled.\n"
},
"invoice": {
"type": "object",
"description": "EXPANDABLE.\nThe invoices to which the invoice item belongs.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code of the invoice item.\n**Note** Only when taxation feature is enabled, this field can be presented.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive"
],
"type": "string",
"description": "The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.\n"
},
"itemType": {
"type": "string",
"description": "The type of the invoice item.\n"
},
"quantity": {
"type": "number",
"description": "The quantity of this item, in the configured unit of measure for the\ncharge.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with the invoice item.\n"
},
"invoiceId": {
"type": "string",
"description": "The unique identifier of the invoice to which this invoice item belongs.\n"
},
"productId": {
"type": "string",
"description": "The ID of the product that the invoice item is created from.\n"
},
"taxAmount": {
"type": "string",
"format": "decimal",
"description": "The amount of tax applied to the charge.\n"
},
"unitPrice": {
"type": "number",
"format": "double",
"description": "The per-unit price of the invoice item."
},
"chargeDate": {
"type": "string",
"format": "date-time",
"description": "The date when the invoice item is charged, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"chargeName": {
"type": "string",
"description": "The name of the charge."
},
"ratePlanId": {
"type": "string",
"description": "The ID of the rate plan that the invoice is created from.\n"
},
"revRecCode": {
"type": "string",
"description": "The revenue recognition code.\n"
},
"amendmentId": {
"type": "string",
"description": "The ID of the amendment associated with the subscription. \n\n**Note**: This field is available only if you do not have Orders enabled for your tenant.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the invoice item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the invoice item was created.\n"
},
"description": {
"type": "string",
"description": "The description of the invoice item."
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the invoice item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the invoice item was last updated.\n"
},
"chargeAmount": {
"type": "string",
"format": "decimal",
"description": "The amount of the charge. \n\nThis amount does not include taxes regardless if the charge's tax mode is inclusive or exclusive.\n"
},
"chargeNumber": {
"type": "string",
"description": "Number of the charge.\n"
},
"subscription": {
"type": "object",
"description": "EXPANDABLE.\nThe invoice to which the invoice item belongs.\n"
},
"fulfillmentId": {
"type": "string",
"description": "The reference ID of the fulfillment associated with the invoice item.\n"
},
"orderLineItem": {
"type": "object",
"description": "EXPANDABLE.\nThe order line item associated with the invoice item.\n"
},
"taxationItems": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe taxation items associated with the invoice item.\n"
},
"accountingCode": {
"type": "string",
"description": "The accounting code associated with the invoice item."
},
"discountAmount": {
"type": "number",
"description": "The amount of the discount.\n"
},
"journalEntryId": {
"type": "string",
"description": "The ID of the journal entry that corresponds to this invoice item.\n"
},
"processingType": {
"enum": [
"Charge",
"Discount",
"Prepayment",
"Tax",
"Rounding"
],
"type": "string",
"description": "The kind of the charge for the invoice item. \n"
},
"ratePlanCharge": {
"type": "object",
"description": "EXPANDABLE.\nThe rate plan charge associated with the invoice item.\n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The end date of the service period for this item, i.e., the last day\nof the service period, as _yyyy-mm-dd_.\n"
},
"sourceItemType": {
"enum": [
"SubscriptionComponent",
"Rounding",
"ProductRatePlanCharge",
"None",
"OrderLineItem"
],
"type": "string",
"description": "The type of the source item.\n"
},
"subscriptionId": {
"type": "string",
"description": "ID of the subscription associated with the invoice item.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the invoice.\n"
},
"orderLineItemId": {
"type": "string",
"description": "The reference ID of the oder line item associated with the invoice item.\n"
},
"parentAccountId": {
"type": "string",
"description": "The parent account of the account associated with the invoice.\n\n**Note**: This field is available only if you have <a\nhref=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\"\ntarget=\"_blank\">Customer Hierarchy</a> enabled for your tenant.\n"
},
"revRecStartDate": {
"type": "string",
"format": "date"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the invoice.\n"
},
"taxExemptAmount": {
"type": "number"
},
"bookingReference": {
"type": "string",
"description": "The booking reference of the invoice item.\n"
},
"ratePlanChargeId": {
"type": "string",
"description": "The ID of the rate plan charge associated with the invoice item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The start date of the service period for this item, as _yyyy-mm-dd_.\nFor a one-time fee item, the date of the charge.\n"
},
"invoiceScheduleId": {
"type": "string",
"description": "The ID of the invoice schedule associated with the rate plan charge on the subscription.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"productRatePlanId": {
"type": "string",
"description": "The ID of the product rate plan that the invoice item is created from.\n"
},
"numberOfDeliveries": {
"type": "number",
"description": "The number of deliveries dedicated to the Delivery Pricing charges. \n**Note**: This field is available only if you have the Delivery Pricing feature enabled. \n"
},
"subscriptionNumber": {
"type": "string",
"description": "Number of the subscription associated with the invoice item.\n"
},
"itemSoldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the invoice item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "The purchase order number associated with the invoice item.\n"
},
"invoiceScheduleItemId": {
"type": "string",
"description": "The ID of the invoice schedule item that generates this invoice item.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"appliedToInvoiceItemId": {
"type": "string",
"description": "The unique ID of the invoice item that the discount charge is applied\nto.\n"
},
"commitmentChargeNumber": {
"type": "string"
},
"defaultPaymentMethodId": {
"type": "string",
"description": "The ID of the default payment method on the associated account.\n"
},
"revRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate"
],
"type": "string",
"description": "The date when revenue recognition is triggered.\n"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot associated with the invoice.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of the product rate plan charge that the invoice item is created from.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the invoice.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The revenue recognition rule of the invoice item.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"itemSoldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the invoice item.\n\n**Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"commitmentChargeSegmentNumber": {
"type": "string"
},
"contractAssetAccountingCodeId": {
"type": "string",
"description": "ID of the accounting code for contract asset. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"deferredRevenueAccountingCodeId": {
"type": "string",
"description": "ID of the deferred revenue accounting code associated with the invoice item.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "ID of the account receivable accounting code associated with the invoice item.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"adjustmentRevenueAccountingCodeId": {
"type": "string",
"description": "The accounting code for adjustment revenue. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"contractLiabilityAccountingCodeId": {
"type": "string",
"description": "ID of the accounting code for contract liability. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"recognizedRevenueAccountingCodeId": {
"type": "string",
"description": "ID of the recognized revenue accounting code associated with the invoice item.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"adjustmentLiabilityAccountingCodeId": {
"type": "string",
"description": "ID of the accounting code for adjustment liability. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"unbilledReceivablesAccountingCodeId": {
"type": "string"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the invoice item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"contractRecognizedRevenueAccountingCodeId": {
"type": "string",
"description": "ID of the accounting code for contract recognized revenue. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
}
NestedInvoiceOnExpand
{
"type": "object",
"title": "QueryInvoiceResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the invoice.\n"
},
"amount": {
"type": "string",
"format": "number",
"description": "The total amount of the invoice.\n"
},
"source": {
"enum": [
"BillRun",
"API",
"ApiSubscribe",
"ApiAmend"
],
"type": "string",
"description": "The source of the invoice.\n"
},
"status": {
"enum": [
"Draft",
"Posted"
],
"type": "string",
"description": "The status of the invoice.\n"
},
"account": {
"type": "object",
"description": "EXPANDABLE.\nThe account associated with the invoice.\n"
},
"autoPay": {
"type": "boolean",
"description": "Whether invoices are automatically picked up for processing in the corresponding payment run.\n"
},
"balance": {
"type": "number",
"format": "double",
"description": "The remaining balance of the invoice after all payments, adjustments, and refunds are applied.\n"
},
"dueDate": {
"type": "string",
"format": "date",
"description": "The date by which the payment for this invoice is due, in `yyyy-mm-dd` format.\n"
},
"comments": {
"type": "string",
"description": "Comments about the invoice.\n"
},
"currency": {
"type": "string",
"nullable": true,
"description": "The currency of the invoice.\n\n**Note:** By default, the currency on a billing document matches the default currency set on the associated account. \nHowever, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. \nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currency</a>.\n"
},
"postedBy": {
"type": "string",
"description": "The user ID of the person who moved the invoice to Posted status.\n"
},
"reversed": {
"type": "boolean",
"description": "Whether the invoice is reversed.\n"
},
"sourceId": {
"type": "string",
"description": "The ID of the invoice source.\nIf an invoice is generated from a bill run, the value is the number of the corresponding bill run.Otherwise, the value is `null`.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the invoice.\n"
},
"taxAmount": {
"type": "string",
"format": "number",
"description": "The amount of taxation.\n"
},
"taxStatus": {
"enum": [
"Complete",
"Error",
"UnknownError",
"DuplicateDoc",
"InvalidRequest",
"InvalidResponse",
"TaxEngineError",
"ConcurrentModify",
"InternalServerError",
"TaxCodeTemplateError"
],
"type": "string",
"description": "The status that the tax engine return after it calculates the taxes of this invoice.\n"
},
"postedDate": {
"type": "string",
"format": "date",
"description": "The date when the invoice was posted.\n"
},
"sourceType": {
"enum": [
"Subscription",
"Standalone",
"Order",
"Consolidation"
],
"type": "string",
"description": "The type of the invoice source.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in this bill run.\n"
},
"taxMessage": {
"type": "string",
"description": "The message that the tax engine return if it calculates the taxes of this invoice fails.\n"
},
"templateId": {
"type": "string",
"description": "The ID of the invoice template.\n\n- If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled, the value of this field depends on the configuration of the invoice template. \n - If you specify an invoice template at the subscription level, the value of this field is automatically populated from the corresponding subscription.\n - If you do not specify any invoice template at the subscription level, the value of this field is automatically populated from the corresponding account.\n- If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the invoice.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the invoice gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"invoiceDate": {
"type": "string",
"format": "date",
"description": "The date that appears on the invoice being created.\n"
},
"paymentLink": {
"type": "string",
"description": "A link to the Payment Link page where the customer can pay the invoice.\n\nThe link is generated only if the invoice is posted after enabling the Payment Link feature on your tenant.\n\n**Note**: The Payment Link feature is in the Early Adopter phase. \nYou can enable the Payment Link feature through a self-service configuration in the **Manage Features** setting for Zuora Payments.\n"
},
"paymentTerm": {
"type": "string",
"description": "The payment term associated with the invoice. For\nexample, `Net 30`. The payment term determines the due dates of\ninvoices.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the invoice.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The time that the invoice gets updated in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe invoice items on the invoice.\n"
},
"refundAmount": {
"type": "string",
"format": "number",
"description": "Specifies the amount of a refund that was applied against an earlier payment on the invoice.\n"
},
"billToContact": {
"type": "object",
"description": "EXPANDABLE.\nThe bill-to contact who pays the invoice.\n"
},
"includesUsage": {
"type": "boolean",
"description": "Specifies whether the invoice includes usage charges.\n"
},
"invoiceNumber": {
"type": "string",
"description": "The unique identification number of the invoice.\n"
},
"paymentAmount": {
"type": "string",
"format": "number",
"description": "The amount of payments applied to the invoice.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the invoice.\n"
},
"eInvoiceFileId": {
"type": "string",
"description": "The ID of the e-invoice file.\n"
},
"eInvoiceStatus": {
"enum": [
"Processing",
"Generated",
"Success",
"Failed"
],
"type": "string",
"description": "It could be Processing, Generated, Success, Failed. If it’s Failed, it will have an error code and message. If it’s Generated or Success, both error code and message are empty, and eInvoiceFileId stores the file id of e-invoice.\n"
},
"organizationId": {
"type": "string",
"description": "ID of the organization this object belongs to.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the invoice.\n"
},
"includesOneTime": {
"type": "boolean",
"description": "Specifies whether the invoice includes one-time charges.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the invoice.\n"
},
"taxExemptAmount": {
"type": "string",
"format": "number",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"adjustmentAmount": {
"type": "string",
"format": "number",
"description": "The amount of the invoice adjustments associated with the invoice.\n"
},
"amountWithoutTax": {
"type": "string",
"format": "number",
"description": "The invoice amount excluding tax.\n"
},
"creditMemoAmount": {
"type": "string",
"format": "number",
"description": "The currency amount of all credit memos applied to this invoice.\n\n**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"eInvoiceErrorCode": {
"type": "string",
"description": "The error code when status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor.\n"
},
"includesRecurring": {
"type": "boolean",
"description": "Specifies whether the invoice includes recurring charges.\n"
},
"lastEmailSentDate": {
"type": "string",
"description": "The date when the invoice was last emailed.\n"
},
"eInvoiceErrorMessage": {
"type": "string",
"description": "The error message when status is \"Failed\". This message can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor.\n"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot associated with the invoice.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the invoice.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Error",
"Ignore",
"Yes",
"No"
],
"type": "string",
"description": "Whether the invoice was transferred to an external accounting system.\n"
},
"creditBalanceAdjustmentAmount": {
"type": "string",
"format": "number",
"description": "The currency amount of the adjustment applied to the customer's credit balance.\n\n **Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.\n"
}
}
}
NestedOrderActionOnExpand
{
"type": "object",
"title": "QueryOrderActionResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the order action.\n"
},
"type": {
"enum": [
"CreateSubscription",
"TermsAndConditions",
"AddProduct",
"UpdateProduct",
"RemoveProduct",
"RenewSubscription",
"CancelSubscription",
"OwnerTransfer",
"Suspend",
"Resume",
"ChangePlan"
],
"type": "string",
"description": "Type of the order action.\n\n**Note**: The change plan type of order action is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.\n"
},
"order": {
"type": "object",
"description": "EXPANDABLE.\nThe order associated with this order action.\n"
},
"orderId": {
"type": "string",
"description": "The unique identifier of the order that the order action belongs to.\n"
},
"subType": {
"enum": [
"Upgrade",
"Downgrade",
"Crossgrade",
"PlanChanged"
],
"type": "string",
"description": "The sub type for the change plan order action.\n\nIf this field was not set by user, the field is automatically generated by the system according to the following rules:\n\nWhen the old and new rate plans are within the same Grading catalog group:\n* If the grade of new plan is greater than that of the old plan, this is an \"Upgrade\".\n* If the grade of new plan is less than that of the old plan, this is a \"Downgrade\".\n* If the grade of new plan equals that of the old plan, this is a \"Crossgrade\".\n\nWhen the old and new rate plans are not in the same Grading catalog group, or either has no group, this is \"PlanChanged\".\n"
},
"sequence": {
"type": "integer",
"format": "int32",
"description": "The sequence of the order actions processed in the order.\n"
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN"
],
"type": "string",
"description": "The type of the subscription term.\n"
},
"autoRenew": {
"type": "boolean",
"default": false,
"description": "If `true`, the subscription automatically renews at the end of the term. \n"
},
"resumeDate": {
"type": "string",
"format": "date",
"description": "The resume date when the resumption takes effect.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the order action.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the order action gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"currentTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the current subscription term.\n"
},
"paymentTerm": {
"type": "string",
"description": "The name of the payment term associated with the subscription. For\nexample, `Net 30`. The payment term determines the due dates of invoices.\n\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"renewalTerm": {
"type": "integer",
"format": "int64",
"default": 0,
"description": "The length of the period for the subscription renewal term. \n"
},
"suspendDate": {
"type": "string",
"format": "date",
"description": "The date when subscription suspension takes effect, in the `yyyy-mm-dd` format.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the order action.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the order action was last updated.\n"
},
"renewSetting": {
"enum": [
"RENEW_WITH_SPECIFIC_TERM",
"RENEW_TO_EVERGREEN"
],
"type": "string",
"default": "RENEW_WITH_SPECIFIC_TERM",
"description": "Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed.\n"
},
"subscription": {
"type": "object",
"description": "EXPANDABLE.\nThe subscription associated with this order action.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the subscription.\n \n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"termStartDate": {
"type": "string",
"format": "date",
"description": "The date on which the subscription term begins, as `yyyy-mm-dd`. If this is a renewal subscription, this date is different from the subscription start date.\n"
},
"subscriptionId": {
"type": "string",
"description": "The unique identifier of the subscription associated with the order action.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"effectivePolicy": {
"enum": [
"EffectiveImmediately",
"EffectiveEndOfBillingPeriod",
"SpecificDate"
],
"type": "string",
"description": "The default value for the `effectivePolicy` field is as follows:\n * If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default.\n * If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default.\n * Otherwise, the effective policy is `SpecificDate` by default.\n\n**Notes**: \n * When setting this field to `EffectiveEndOfBillingPeriod`, you cannot set the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/W_Subscription_and_Amendment_Dates#Billing_Trigger_Dates\" target=\"_blank\">billing trigger dates</a> for the subscription as the system will automatically set the trigger dates to the end of billing period.\n * When setting this field to `SpecificDate`, you must also set the `contractEffectiveDate` field.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"cancellationPolicy": {
"enum": [
"EndOfCurrentTerm",
"EndOfLastInvoicePeriod",
"SpecificDate"
],
"type": "string",
"description": "Cancellation method. \n"
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "Effective contract date for this subscription, as yyyy-mm-dd.\n"
},
"currentTermPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"default": "Month",
"description": "The period type for the current subscription term.\n"
},
"renewalTermPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"default": "Month",
"description": "The period type for the subscription renewal term.\n\nThis field is used with the `renewalTerm` field to specify the subscription renewal term.\n"
},
"serviceActivationDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd.\n"
},
"customerAcceptanceDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.\n"
},
"cancellationEffectiveDate": {
"type": "string",
"format": "date",
"description": "Date when the cancellation takes effect, in the `yyyy-mm-dd` format. Used only if `cancellationPolicy` is `SpecificDate`. It should not be earlier than the subscription contract-effective date, later than the subscription term-end date, or within a period for which the customer has been invoiced.\n"
},
"clearingExistingPaymentTerm": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingSequenceSet": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingBillToContact": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingSoldToContact": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"subscriptionVersionAmendmentId": {
"type": "string",
"description": "The unique identifier of the amendment that changes the version of the subscription.\n"
},
"clearingExistingInvoiceTemplate": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
}
}
}
NestedOrderLineItemOnExpand
{
"type": "object",
"title": "QueryOrderLineItemResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the order line item.\n"
},
"uOM": {
"type": "string",
"description": "Specifies the units to measure usage.\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"amount": {
"type": "number",
"description": "The total amount for the Order Line Item (OLI).\n"
},
"soldTo": {
"type": "string",
"description": "The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the sold-to contact of an order line item.\n"
},
"orderId": {
"type": "string",
"description": "The ID of the order that the order line item belongs to.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"taxMode": {
"enum": [
"TaxInclusive",
"TaxExclusive"
],
"type": "string",
"description": "The tax mode for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"billToId": {
"type": "string",
"description": "The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the bill-to contact of an order line item.\n"
},
"discount": {
"type": "number",
"description": "This field shows the total discount amount that is applied to an order line item after the `inlineDiscountType`, `inlineDiscountPerUnit` and `quantity` fields are set.\n\nThe inline discount is applied to the list price of an order line item.\n"
},
"itemName": {
"type": "string",
"description": "The name of the Order Line Item (OLI).\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"itemType": {
"enum": [
"Product",
"Fee",
"Services"
],
"type": "string",
"description": "The type of the Order Line Item (OLI). \n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"quantity": {
"type": "number",
"description": "The quantity of units, such as the number of authors in a hosted wiki service.\n\nYou can update this field for a sales or return OLI only when the OLI in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"itemState": {
"enum": [
"Executing",
"Booked",
"SentToBilling",
"Complete",
"Cancelled"
],
"type": "string",
"description": "The state of the Order Line Item (OLI). See [State transitions for an order, order line item, and fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States) for more information.\n\nTo generate invoice for an OLI, you must set this field to `SentToBilling` and set the `billTargetDate` field .\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` or 'Booked' or `SentToBilling`state (when the `itemState` field is set as `Executing` or `SentToBilling`).\n"
},
"listPrice": {
"type": "number",
"description": "The extended list price for an order line item, calculated by the formula:\nlistPrice = listPricePerUnit * quantity\n"
},
"itemNumber": {
"type": "string",
"description": "The number for the Order Line Item (OLI).\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"billingRule": {
"enum": [
"TriggerWithoutFulfillment",
"TriggerAsFulfillmentOccurs"
],
"type": "string",
"description": "The billing rule of the Order Line Item.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the order line item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the order line item gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"description": {
"type": "string",
"description": "The description of the Order Line Item.\n"
},
"productCode": {
"type": "string",
"description": "The product code for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the order line item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the order line item was last updated.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE. The invoice item associated with the order line item."
},
"itemCategory": {
"enum": [
"Sales",
"Return"
],
"type": "string",
"default": "Sales",
"description": "The category of the Order Line Item, to indicate a product sale or return.\n"
},
"amountPerUnit": {
"type": "number",
"description": "The actual charged amount per unit for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"accountingCode": {
"type": "string",
"description": "The accountingCode for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"billTargetDate": {
"type": "string",
"format": "date",
"description": "The target date for the Order Line Item (OLI) to be picked up by bill run for generating billing documents.\n\nTo generate billing documents for an OLI, you must set this field and set the `itemState` field to `SentToBilling`.\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"ownerAccountId": {
"type": "string",
"description": "The account ID of the owner of the order line item.\n"
},
"originalOrderId": {
"type": "string",
"description": "The ID of the original sale order for a return order line item. \n"
},
"transactionDate": {
"type": "string",
"format": "date",
"description": "The date when the transaction occurs.\n"
},
"amendedByOrderOn": {
"type": "string",
"format": "date",
"description": "The date of the amended order for a return order line item.\n"
},
"amountWithoutTax": {
"type": "number",
"description": "The total amount for the Order Line Item (OLI) excluding tax.\n"
},
"billToSnapshotId": {
"type": "string",
"description": "The snapshot of the ID for an account used as the bill-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `billToSnapshotId` field is exposed while retrieving the order line item details.\n"
},
"listPricePerUnit": {
"type": "number",
"description": "The list price per unit for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"soldToSnapshotId": {
"type": "string",
"description": "The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `soldToSnapshotId` field is exposed while retrieving the order line item details.\n"
},
"originalOrderDate": {
"type": "string",
"format": "date",
"description": "The date of the original sale order for a return order line item.\n"
},
"quantityFulfilled": {
"type": "number",
"description": "The fulfilled quantity for an order line item.\n"
},
"inlineDiscountType": {
"enum": [
"Percentage",
"FixedAmount",
"None"
],
"type": "string",
"description": "This field is used to specify the inline discount type, which can be `Percentage`, `FixedAmount`, or `None`. The default value is `Percentage`.\n\nThis field is used together with the `inlineDiscountPerUnit` field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item. \n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"
},
"transactionEndDate": {
"type": "string",
"format": "date",
"description": "The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the `transactionStartDate` field.\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"originalOrderNumber": {
"type": "string",
"description": "The number of the original sale order for a return order line item. \n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "Used by customers to specify the Purchase Order Number provided by the buyer.\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"requiresFulfillment": {
"type": "boolean",
"description": "The flag to show whether fulfillment is needed or not. It's derived from billing rule of the Order Line Item.\n"
},
"soldToOrderContactId": {
"type": "string",
"description": "The ID of the sold-to contact for the order.\n"
},
"transactionStartDate": {
"type": "string",
"format": "date",
"description": "The date a transaction starts. The default value of this field is the order date.\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"inlineDiscountPerUnit": {
"type": "number",
"description": "This field is used in accordance with the `inlineDiscountType` field, in the following manner:\n* If the `inlineDiscountType` field is set as `Percentage`, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify `5` in this field, the discount percentage is 5%.\n* If the `inlineDiscountType` field is set as `FixedAmount`, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify `10` in this field, the discount amount on each unit of the order line item is 10.\n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"
},
"invoiceOwnerAccountId": {
"type": "string",
"description": "The account ID of the invoice owner of the order line item.\n"
},
"revenueRecognitionRule": {
"type": "string",
"description": "The Revenue Recognition rule for the Order Line Item.\n"
},
"originalOrderLineItemId": {
"type": "string",
"description": "The ID of the original sale order line item for a return order line item. \n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "ID of a Product Rate Plan Charge. Only one-time charges are supported.\n"
},
"relatedSubscriptionNumber": {
"type": "string",
"description": "This field is used to relate an order line item to an subscription. \n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"quantityAvailableForReturn": {
"type": "number",
"description": "The quantity that can be returned for an order line item. \n"
},
"quantityPendingFulfillment": {
"type": "number",
"description": "The quantity to fulfill for an order line item. \n"
},
"contractAssetAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"originalOrderLineItemNumber": {
"type": "string",
"description": "The number of the original sale order line item for a return order line item. \n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"deferredRevenueAccountingCodeId": {
"type": "string",
"description": "The deferred revenue accounting code for the Order Line Item.\n"
},
"adjustmentRevenueAccountingCodeId": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"recognizedRevenueAccountingCodeId": {
"type": "string",
"description": "The recognized revenue accounting code for the Order Line Item.\n"
},
"adjustmentLiabilityAccountingCodeId": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"unbilledReceivablesAccountingCodeId": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related rate plan charges and order line items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.\n"
},
"contractRecognizedRevenueAccountingCodeId": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
}
}
}
NestedOrderOnExpand
{
"type": "object",
"title": "QueryOrdersResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the order.\n"
},
"state": {
"type": "string",
"description": "The state of the bill-to address. The value is a valid state\n or province name or 2-character abbreviation.\n"
},
"status": {
"enum": [
"Draft",
"Pending",
"Completed",
"Cancelled",
"Scheduled",
"Executing",
"Failed"
],
"type": "string",
"description": "The status of the order. If the order contains any `Pending\nActivation` or `Pending Acceptance` subscription, the order status\nwill be `Pending`; If the order is in draft status, the order status\nwill be `Draft`; otherwise the order status is `Completed`.\n\n\nThe available order statuses are as follow:\n\n- `Draft`: The order is in draft status.\n\n- `Pending`: The order is in pending status.\n\n- `Completed`: The order is in completed status.\n\n- `Cancelled`: The draft or scheduled order is cancelled.\n\n- `Scheduled`: The order is in scheduled status and it is only valid\nif the Scheduled Orders feature is enabled.\n\n- `Executing`: The scheduled order is executed by a scheduler and it\nis only valid if the Scheduled Orders feature is enabled.\n\n- `Failed`: The scheduled order has failed.\n\n\n**Note**: To manage and access the <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/AA_Overview_of_Orders/P_Scheduled_Orders\"\ntarget=\"_blank\">Scheduled Orders</a> feature from the self-service\ninterface, see <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself\"\ntarget=\"_blank\">Enable billing features by yourself</a>.\n"
},
"account": {
"$ref": "#/components/schemas/NestedAccountOnExpand"
},
"category": {
"type": "string"
},
"response": {
"type": "string"
},
"accountId": {
"type": "string",
"description": "The unique identifier of the customer account associated with the\norder.\n"
},
"errorCode": {
"type": "string",
"description": "The error code of the error response.\n"
},
"orderDate": {
"type": "string",
"format": "date",
"description": "The date when the order is signed. All the order actions under this\norder will use this order date as the contract effective date if no\nadditinal contractEffectiveDate is provided.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the order.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the order gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"description": {
"type": "string",
"description": "The description of the order.\n"
},
"orderNumber": {
"type": "string",
"description": "The unique identifier of the order.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the order.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the order was last updated.\n"
},
"errorMessage": {
"type": "string",
"description": "The error message of the error response.\n"
},
"orderActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedOrderActionOnExpand"
}
},
"scheduledDate": {
"type": "string",
"format": "date",
"description": "The date for the order scheduled.\n"
},
"orderLineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NestedOrderLineItemOnExpand"
}
},
"invoiceScheduleId": {
"type": "string",
"description": "The unique identifier of the invoice schedule associated with the\norder.\n"
},
"createdByMigration": {
"type": "boolean",
"description": "Indicates whether the order is created by migration.\n"
},
"scheduledDatePolicy": {
"enum": [
"SpecificDate"
],
"type": "string",
"description": "Date policy of the scheduled order."
}
}
}
NestedPaymentMethodOnExpand
{
"type": "object",
"title": "QueryPaymentMethodResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the payment method.\n"
},
"city": {
"type": "string",
"description": "The city of the customer's address. Applicable to debit payment methods.\n"
},
"iBAN": {
"type": "string",
"description": "The International Bank Account Number used to create the SEPA payment method. The value is masked.\n"
},
"name": {
"type": "string",
"description": "The name of the payment method.\n"
},
"type": {
"type": "string",
"description": "The type of the payment method. For example, `CreditCard`.\n"
},
"email": {
"type": "string",
"description": "The email address of the payment method holder.\n"
},
"phone": {
"type": "string",
"description": "The phone number that the account holder registered with the bank. This\nfield is used for credit card validation when passing to a gateway.\n"
},
"state": {
"type": "string",
"description": "The state of the customer's address. Only applicable to direct debit\npayment methods.\n"
},
"active": {
"type": "boolean",
"description": "Indicates whether the payment method is active.\n"
},
"account": {
"type": "object",
"description": "EXPANDABLE.\nThe account to which the payment method belongs.\n"
},
"achCity": {
"type": "string",
"maxLength": 40,
"description": "City for the ACH payment method.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"country": {
"type": "string",
"description": "The two-letter country code of the customer's address. Applicable to direct debit payment methods."
},
"subType": {
"type": "string",
"description": "The identification reference indicating the subtype of the custom payment method.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.\n"
},
"tokenId": {
"type": "string",
"description": "A gateway unique identifier that replaces sensitive payment method data or\nrepresents a gateway's unique customer profile. Applicable to CC Reference\nTransaction payment methods.\n"
},
"achState": {
"type": "string",
"description": "State for the ACH payment method. Must be a valid state name or 2-character abbreviation.\n\nSee [United States Standard State Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/B_State_Names_and_2-Digit_Codes) and [Canadian Standard Province Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/C_Canadian_Province_Names_and_2-Digit_Codes) for the list of supported names and abbreviations.\n"
},
"bankCity": {
"type": "string",
"description": "The city of the direct debit bank."
},
"bankCode": {
"type": "string",
"description": "The sort code or number that identifies the bank. This is also known as the sort code. \n"
},
"bankName": {
"type": "string",
"description": "The name of the direct debit bank."
},
"isSystem": {
"type": "boolean",
"description": "Indicates whether the payment method is a system-generated payment method.\n"
},
"lastName": {
"type": "string",
"description": "The customer's last name. Only applicable to direct debit payment methods.\n"
},
"accountId": {
"type": "string",
"description": "The unique identifier of the account that the payment method is\nassociated with.\n"
},
"firstName": {
"type": "string",
"description": "The customer's first name. Only applicable to direct debit payment methods.\n"
},
"iPAddress": {
"type": "string",
"description": "The IP address of the user when the payment method was created or updated.\n"
},
"isCompany": {
"type": "boolean",
"description": "Whether the customer account is a company.\n"
},
"mandateId": {
"type": "string",
"description": "The mandate ID.\n"
},
"achAbaCode": {
"type": "string",
"description": "The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`.\n"
},
"achCountry": {
"type": "string",
"description": "Country for the ACH payment method. Must be a valid country name or abbreviation.\n\nSee <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions\" target=\"_blank\">View countries or regions</a> for the list of supported country names and abbreviations.\n\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"paypalBaid": {
"type": "string",
"example": "I-1TJ3GAGG82Y9",
"description": "ID of a PayPal billing agreement. \n"
},
"paypalType": {
"type": "string",
"description": "The type of the PayPal payment method.\n"
},
"postalCode": {
"type": "string",
"description": "The zip code of the customer's address. Only applicable to direct debit\npayment methods.\n"
},
"streetName": {
"type": "string",
"description": "The street name of the customer's address. Only applicable to direct debit\npayment methods.\n"
},
"achAddress1": {
"type": "string",
"maxLength": 255,
"description": "First address line for the ACH payment method.\n"
},
"achAddress2": {
"type": "string",
"maxLength": 255,
"description": "Second address line for the ACH payment method.\n"
},
"achBankName": {
"type": "string",
"maxLength": 70,
"description": "The name of the bank where the ACH payment account is held.\n\nWhen creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value.\n"
},
"companyName": {
"type": "string",
"description": "The name of the company.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the payment method.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment method gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"paypalEmail": {
"type": "string",
"description": "Email address associated with the PayPal payment method. \n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the payment method.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment method gets updated in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"streetNumber": {
"type": "string",
"description": "The street number of the customer's address. Only applicable to direct\ndebit payment methods.\n"
},
"achPostalCode": {
"type": "string",
"maxLength": 20,
"description": "Zip code or postal code for the ACH payment method.\n"
},
"mandateReason": {
"type": "string",
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"description": "The status of the mandate from the gateway side.\n"
},
"secondTokenId": {
"type": "string",
"description": "A gateway unique identifier that replaces sensitive payment method data.\n\n**Note:** This field is only returned for the Credit Card Reference Transaction payment type.\n"
},
"achAccountName": {
"type": "string",
"description": "The name of the account holder, which can be either a person or a company. This field is only required if the `type` field is set to `ACH`.\n"
},
"achAccountType": {
"enum": [
"BusinessChecking",
"Checking",
"Saving"
],
"type": "string",
"description": "The type of bank account associated with the ACH payment method. This field is only required if the `type` field is set to `ACH`.\n\nWhen creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, `Checking` preferably.\n"
},
"bankBranchCode": {
"type": "string",
"description": "The branch code of the bank used for Direct Debit. \n"
},
"bankCheckDigit": {
"type": "string",
"description": "The check digit in the international bank account number, which confirms the validity of the account. Applicable to direct debit payment methods."
},
"bankPostalCode": {
"type": "string",
"description": "The zip code or postal code of the direct debit bank."
},
"bankStreetName": {
"type": "string",
"description": "The name of the street of the direct debit bank."
},
"creditCardCity": {
"type": "string",
"description": "The city of the card holder's address. Applicable to credit card and\ndirect debit payment methods.\n"
},
"creditCardType": {
"type": "string",
"description": "The type of the credit card or debit card.\n\nPossible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).\n\n**Note:** This field is only returned for the Credit Card and Debit Card payment types.\n"
},
"identityNumber": {
"type": "string",
"description": "The identity number of the account holder or the cardholder.\n"
},
"creditCardState": {
"type": "string",
"description": "The state where the credit card holder stays.\n"
},
"deviceSessionId": {
"type": "string",
"description": "The session ID of the user when the `PaymentMethod` was created or updated.\n"
},
"existingMandate": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Indicates whether the mandate is an existing mandate.\n"
},
"mandateReceived": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Indicates whether the mandate is received from the gateway.\n"
},
"userReferenceId": {
"type": "string",
"description": "The identification reference of the user or customer account.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.\n"
},
"bankStreetNumber": {
"type": "string",
"description": "The number of the direct debit bank."
},
"bankTransferType": {
"enum": [
"AutomatischIncasso",
"LastschriftDE",
"LastschriftAT",
"DemandeDePrelevement",
"DirectDebitUK",
"Domicil",
"LastschriftCH",
"RID",
"OrdenDeDomiciliacion",
"Autogiro",
"Betalingsservice"
],
"type": "string",
"description": "Specifies the type of direct debit transfer. The value of this field is dependent on the country of the user.\n\nPossible Values: \n\n\n* `AutomatischIncasso` (NL)\n\n* `LastschriftDE` (Germany)\n\n* `LastschriftAT` (Austria)\n\n* `DemandeDePrelevement` (FR)\n\n* `DirectDebitUK` (UK)\n\n* `Domicil` (Belgium)\n\n* `LastschriftCH` (CH)\n\n* `RID` (Italy)\n\n* `OrdenDeDomiciliacion` (Spain)\n* `Autogiro` (Sweden)\n* `Betalingsservice` (Denmark)\n"
},
"creditCardCountry": {
"type": "string",
"description": "The country where the credit card holder stays.\n\nWhen creating a payment method through a translated UI or Payment Page, a country name in a translated language might be selected. \nRegardless of the country texts selected when creating the payment method, only the supported country name returns in this field. \nFor a complete list of supported country names, see <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions\" target=\"_blank\">View countries or regions</a>. \nInternationalization is not supported for the API field value.\n"
},
"mandateUpdateDate": {
"type": "string",
"format": "date",
"description": "The date on which the mandate was updated.\n"
},
"methodReferenceId": {
"type": "string",
"description": "The identification reference of the custom payment method.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query.\n"
},
"creditCardAddress1": {
"type": "string",
"description": "The first line of the card holder's address, which is often a street\naddress or business name. Applicable to credit card and direct debit\npayment methods.\n"
},
"creditCardAddress2": {
"type": "string",
"description": "The second line of the card holder's address. Applicable to credit card\nand direct debit payment methods.\n"
},
"methodSpecificData": {
"type": "string",
"description": "Other method-specific data of the payment method.\n"
},
"paymentRetryWindow": {
"type": "integer",
"format": "int32",
"description": "The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours.\n"
},
"mandateCreationDate": {
"type": "string",
"format": "date",
"description": "The date on which the mandate was created.\n"
},
"paymentMethodStatus": {
"enum": [
"Active",
"Closed",
"Scrubbed"
],
"type": "string",
"description": "The status of the payment method.\n"
},
"useDefaultRetryRule": {
"type": "boolean",
"description": "Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings.\n"
},
"achAccountNumberMask": {
"type": "string",
"description": "The masked bank account number associated with the ACH payment method. This field is only required if the `type` field is set to `ACH`.\n"
},
"creditCardHolderName": {
"type": "string",
"description": "The full name of the credit card holder.\n"
},
"creditCardMaskNumber": {
"type": "string",
"description": "The masked credit card number, such as `*********1112`.\n"
},
"creditCardPostalCode": {
"type": "string",
"description": "The postal code for the address of the credit card holder.\n"
},
"paypalPreapprovalKey": {
"type": "string",
"description": "The PayPal preapproval key.\n"
},
"lastTransactionStatus": {
"type": "string",
"description": "The status of the most recent transaction."
},
"numConsecutiveFailures": {
"type": "integer",
"format": "int32",
"description": "The number of consecutive failed payments for this payment method. It is reset to `0` upon successful payment. \n"
},
"bankTransferAccountName": {
"type": "string",
"description": "The name on the direct debit bank account."
},
"bankTransferAccountType": {
"type": "string",
"description": "The type of the customer's bank account. Applicable to direct debit\npayment methods.\n"
},
"lastTransactionDateTime": {
"type": "string",
"format": "date-time",
"description": "The date and time of the most recent transaction.\n"
},
"bankIdentificationNumber": {
"type": "string",
"description": "The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method."
},
"creditCardExpirationYear": {
"type": "integer",
"format": "int32",
"description": "Four-digit expiration year.\n"
},
"creditCardExpirationMonth": {
"type": "integer",
"format": "int32",
"maximum": 12,
"minimum": 1,
"description": "One or two digits expiration month.\n"
},
"businessIdentificationCode": {
"type": "string",
"description": "The business identification code for Swiss direct payment methods that use\nthe Global Collect payment gateway. Only applicable to direct debit\npayment methods in Switzerland with Global Collect.\n"
},
"totalNumberOfErrorPayments": {
"type": "integer",
"format": "int32",
"description": "The number of error payments that used this payment method."
},
"bankTransferAccountNumberMask": {
"type": "string",
"description": "This is a masked displayable version of the bank account number, used for\nsecurity purposes. For example: `XXXXXXXXX54321`.\n"
},
"lastFailedSaleTransactionDate": {
"type": "string",
"format": "date",
"description": "The date of the last failed attempt to collect payment with this payment\nmethod.\n"
},
"maxConsecutivePaymentFailures": {
"type": "integer",
"format": "int32",
"description": "The number of allowable consecutive failures Zuora attempts with the payment method before stopping.\n"
},
"totalNumberOfProcessedPayments": {
"type": "integer",
"format": "int32",
"description": "The number of successful payments that used this payment method."
}
}
}
NestedPaymentOnExpand
{
"type": "object",
"title": "QueryPaymentResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the payment.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the payment.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment.\n"
},
"source": {
"enum": [
"PaymentRun",
"Import",
"Manually",
"API"
],
"type": "string",
"description": "Indicates how the payment was created, whether through API, manually, import, or payment run.\n"
},
"status": {
"enum": [
"Draft",
"Processing",
"Processed",
"Error",
"Canceled",
"Posted"
],
"type": "string",
"description": "The status of the payment.\n"
},
"account": {
"type": "object",
"description": "EXPANDABLE.\nThe account associated with the payment.\n"
},
"comment": {
"type": "string",
"description": "Comments about the payment.\n"
},
"gateway": {
"type": "string",
"description": "Name of the gateway instance that processes the payment. \n"
},
"currency": {
"type": "string",
"example": "USD",
"description": "When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI.\n\nWhen Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.\n"
},
"payoutId": {
"type": "string",
"description": "The payout ID of the payment from the gateway side.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account that the payment is for.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways.\n"
},
"prepayment": {
"type": "boolean",
"description": "Indicates whether the payment is used as a reserved payment. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.\n"
},
"sourceName": {
"type": "string",
"description": "Name of the source. It can be a payment run number or a file name.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date when the payment was canceled.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the payment.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was submitted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the payment.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The time that the payment gets updated in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"gatewayState": {
"enum": [
"MarkedForSubmission",
"Submitted",
"Settled",
"NotSubmitted",
"FailedToSettle"
],
"type": "string",
"description": "The status of the payment in the gateway; use for reconciliation. \n"
},
"isStandalone": {
"type": "boolean",
"description": "Indicates whether the payment is a standalone payment. A standalone\npayment is a payment that is not associated with any invoice or\nsubscription.\n"
},
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the payment that is refunded.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the payment.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date and time when the payment takes effect, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethod": {
"type": "object",
"description": "EXPANDABLE.\nThe payment method used for this payment.\n"
},
"paymentNumber": {
"type": "string",
"example": "P-00000028.",
"description": "The unique identification number of a payment. \n"
},
"accountingCode": {
"type": "string",
"description": "The accounting code for the charge. Accounting codes group\ntransactions that contain similar accounting attributes.\n"
},
"gatewayOrderId": {
"type": "string",
"description": "A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created.\n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the payment. This message is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the payment.\n"
},
"paymentOptionId": {
"type": "string",
"description": "ID of the paymentOption object, which describe the transactional level rules for processing payments. \n"
},
"unappliedAmount": {
"type": "number",
"description": "The unapplied amount of the payment.\n"
},
"authTransactionId": {
"type": "string",
"description": "The authorization transaction ID from the payment gateway.\n"
},
"lastEmailDateTime": {
"type": "string",
"description": "The date and time when the last email was sent to the customer for the payment.\n"
},
"transactionSource": {
"enum": [
"C_Unscheduled",
"M_Recurring",
"M_Unscheduled",
"M_MOTO"
],
"type": "string",
"description": "Payment transaction source used to differentiate the transaction source in Stored Credential Transaction framework.\n - `C_Unscheduled`: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates.\n - `M_Recurring`: Merchant-initiated transaction (MIT) that occurs at regular intervals.\n - `M_Unscheduled`: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates.\n - `M_MOTO`: Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See [Overview of Stripe payment gateway integration](https://knowledgecenter.zuora.com/Zuora_Collect/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration) for more information.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the payment. This code is gateway-dependent.\n"
},
"paymentApplications": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE. \nThe payment applications associated with the payment.\n"
},
"referencedPaymentID": {
"type": "string",
"description": "The ID of a referenced payment. \n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.\n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a charge was marked and waiting for batch\nsubmission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"gatewayTransactionState": {
"type": "string"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankIdentificationNumber": {
"type": "string",
"description": "The first six or eight digits of the credit card or debit card used for the payment, when applicable. \nUse this field to <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DF_Reconciling_Payments_with_Merchant_Accounts\" target=\"_blank\">reconcile payments between the gateway and merchant banks</a>.\n"
},
"secondPaymentReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"appliedCreditBalanceAmount": {
"type": "number",
"description": "The amount of the payment to apply to a credit balance. \n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
}
NestedPrepaidBalanceFundOnExpand
{
"type": "object",
"title": "QueryPrepaidBalanceFundResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the prepaid balance fund.\n"
},
"done": {
"type": "integer",
"format": "int32"
},
"source": {
"type": "object",
"description": "EXPANDABLE.\nThe rate plan charge associated with the prepaid balance fund.\n"
},
"account": {
"type": "object",
"description": "EXPANDABLE.\nThe account associated with the prepaid balance fund.\n"
},
"balance": {
"type": "number",
"description": "The remaining balance (remaining units) on the fund.\n"
},
"endDate": {
"type": "string",
"format": "date",
"description": "End date of the fund effective period.\n"
},
"priority": {
"enum": [
10,
50,
100
],
"type": "integer",
"format": "int32",
"description": "The priority of the Fund. Possible values include: 10(high), 50(medium),100(low)\n"
},
"sourceId": {
"type": "string",
"description": "The source Id of the fund. It is the original charge ID. \n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account to which the prepaid balance fund belongs.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "Start date of the fund effective period.\n"
},
"vpSummary": {
"type": "object",
"description": "EXPANDABLE.\nThe validity period summary associated with the prepaid balance fund.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the prepaid balance fund.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the prepaid balance fund was created.\n"
},
"totalBilled": {
"type": "number"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the prepaid balance fund.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the prepaid balance fund was last updated.\n"
},
"vpSummaryId": {
"type": "string"
},
"fundingPrice": {
"type": "number",
"description": "The price amount of a fund. A rounded value that follows the associated invoice owner's <a href=\"https://knowledgecenter.zuora.com/Quick_References/Rounding_and_Precision#Currency_rounding_rules\" target=\"_blank\">currency rounding rule</a>. \n\n**Calculation**: (Number of billing periods in one fund validity period) * (price in one billing period)\n"
},
"originFundId": {
"type": "string"
},
"totalBalance": {
"type": "number"
},
"fundedBalance": {
"type": "number",
"description": "The total units of the fund. \n"
},
"rolloverCount": {
"type": "integer",
"format": "int32"
},
"fundSourceType": {
"enum": [
"CHARGE",
"ORDER_LINE_ITEM",
"CREDIT_MEMO_ITEM",
"DEBIT_MEMO_ITEM"
],
"type": "string",
"description": "The type of the Prepaid Balance Fund. \n"
},
"prepaidBalance": {
"type": "object",
"description": "EXPANDABLE.\nThe prepaid balance that contains the prepaid balance fund.\n"
},
"prepaidBalanceId": {
"type": "string",
"description": "The ID of the prepaid balance associated to which this prepaid balance fund belongs.\n"
},
"chargeSegmentNumber": {
"type": "integer",
"format": "int32",
"description": "The number of the charge segment. One prepaid balance fund can only belong to one charge segment.\n"
},
"originalFundEndDate": {
"type": "string",
"format": "date"
},
"rolloverApplyOption": {
"type": "string"
},
"originalFundingPrice": {
"type": "number"
},
"originalTotalBalance": {
"type": "number"
},
"rolloverValidityPeriodEndDate": {
"type": "string",
"format": "date"
},
"rolloverValidityPeriodStartDate": {
"type": "string",
"format": "date"
}
}
}
NestedPrepaidBalanceOnExpand
{
"type": "object",
"title": "QueryPrepaidBalanceResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the prepaid balance.\n"
},
"uOM": {
"type": "string",
"description": "The units of measure for prepayment charge. Units of measure\nare configured in the web-based UI. Your values depend on your\nconfiguration in **Billing Settings**.\n\n**Values**: a valid unit of measure\n"
},
"name": {
"type": "string",
"description": "The name of the prepaid balance.\n"
},
"account": {
"type": "object",
"description": "EXPANDABLE.\nThe account associated with the prepaid balance.\n"
},
"balance": {
"type": "number",
"description": "The current prepaid balance.\n"
},
"endDate": {
"type": "string",
"format": "date",
"description": "End date of the validity period."
},
"accountId": {
"type": "string",
"description": "The ID of the customer account to which the prepaid balance belongs.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "Start date of the validity period."
},
"totalFund": {
"type": "number",
"description": "The total amount of all prepaid balance funds.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the payment application.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment application was created.\n"
},
"prepaidType": {
"enum": [
null
],
"type": "object",
"format": "int32",
"nullable": true,
"description": "The type of the prepaid balance.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the payment application.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment application was last updated.\n"
},
"origSubscription": {
"type": "object",
"description": "EXPANDABLE.\nThe subscription associated with the prepaid balance.\n"
},
"origSubscriptionId": {
"type": "string",
"description": "If it belongs to a subscription, the original subscription ID.\n"
},
"prepaidBalanceState": {
"enum": [
"ACTIVE",
"EXPIRED"
],
"type": "string",
"description": "The state of the prepaid balance. \n"
}
}
}
NestedProductOnExpand
{
"type": "object",
"title": "QueryProductResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the product.\n"
},
"sKU": {
"type": "string",
"description": "The unique SKU for the product.\n"
},
"name": {
"type": "string",
"description": "The name of the product. This information is displayed in the product\ncatalog pages in the web-based UI.\n"
},
"category": {
"enum": [
"Base Products",
"Add On Services",
"Miscellaneous Products"
],
"type": "string",
"description": "Category of the product. Used by Zuora Quotes Guided Product Selector.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the product.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the product was created.\n"
},
"description": {
"type": "string",
"description": "A description of the product. \n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the product.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the product was last updated.\n"
},
"productNumber": {
"type": "string",
"description": "The product number of the product.\n"
},
"effectiveEndDate": {
"type": "string",
"format": "date",
"description": "The date when the product expires and can't be subscribed to anymore,\nin the `yyyy-mm-dd` format.\n"
},
"productRatePlans": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE. The product rate plans contained in this product."
},
"effectiveStartDate": {
"type": "string",
"format": "date",
"description": "The date when the product becomes available and can be subscribed to, in the `yyyy-mm-dd` format.\n"
},
"allowFeatureChanges": {
"type": "boolean",
"default": false,
"description": "Controls whether to allow your users to add or remove features while creating or amending a subscription.\n"
}
}
}
NestedProductRatePlanOnExpand
{
"type": "object",
"title": "QueryProductRatePlanResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the product rate plan.\n"
},
"name": {
"type": "string",
"description": "The name of the product rate plan.\n"
},
"grade": {
"type": "integer",
"format": "int32",
"description": "The grade of the product rate plan.\n\n\n**Note**: This field is in the **Early Adopter** phase. We are\nactively soliciting feedback from a small set of early adopters before\nreleasing it as generally available. If you want to join this early\nadopter program, submit a request at [Zuora Global\nSupport](http://support.zuora.com/).\n"
},
"product": {
"type": "object",
"description": "EXPANDABLE.\nThe product associated with the product rate plan.\n"
},
"productId": {
"type": "string",
"description": "The unique identifier of the product to which this product rate\nplan belongs.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the product rate plan.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the product rate plan was created.\n"
},
"description": {
"type": "string",
"description": "A description of the product rate plan.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the product rate plan.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the product rate plan was last updated.\n"
},
"effectiveEndDate": {
"type": "string",
"format": "date",
"description": "Final date the rate plan is active, as `yyyy-mm-dd`. After this date,\nthe rate plan status is `Expired`.\n"
},
"effectiveStartDate": {
"type": "string",
"format": "date",
"description": "First date the rate plan is active (i.e., available to be subscribed\nto), as `yyyy-mm-dd`. Before this date, the status is `NotStarted`.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "The natural key of the product rate plan. \n"
},
"productRatePlanCharges": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe product rate plan charges on the product rate plan.\n"
}
}
}
NestedPrpcOnExpand
{
"type": "object",
"title": "QueryProductRatePlanChargeResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the product rate plan charge.\n"
},
"uOM": {
"type": "string",
"nullable": true,
"description": "Describes the Units of Measure (uom) configured in **Settings >\nBilling** for the productRatePlanCharges.\n"
},
"name": {
"type": "string",
"description": "Name of the product rate-plan charge. Not required to be unique.\n"
},
"taxCode": {
"type": "string",
"description": "Specifies the tax code for taxation rules; used by Zuora Tax.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive",
null
],
"type": "string",
"nullable": true,
"description": "Specifies how to define taxation for the charge; used by Zuora Tax.\n"
},
"taxable": {
"type": "boolean",
"description": "Specifies whether the charge is taxable; used by Zuora Tax. \n"
},
"isPrepaid": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled.\n\n\nIndicates whether this charge is a prepayment (topup) charge or a\ndrawdown charge. \n"
},
"chargeType": {
"enum": [
"OneTime",
"Recurring",
"Usage"
],
"type": "string",
"description": "Specifies the type of charge.\n"
},
"isRollover": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled.\n\n\nIt determines whether the rollover fields are needed.\n"
},
"prepaidUom": {
"type": "string",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled.\n\n\nUnit of measurement for a [prepayment\ncharge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"revRecCode": {
"type": "string",
"nullable": true,
"maxLength": 70,
"description": "Associates this product rate plan charge with a specific revenue\nrecognition code.\n"
},
"chargeModel": {
"enum": [
"Discount-Fixed Amount",
"Discount-Percentage",
"Flat Fee Pricing",
"Per Unit Pricing",
"Overage Pricing",
"Tiered Pricing",
"Tiered with Overage Pricing",
"Volume Pricing",
"Delivery Pricing",
"MultiAttributePricing",
"PreratedPerUnit",
"PreratedPricing`",
"HighWatermarkVolumePricing",
"HighWatermarkTieredPricing"
],
"type": "string",
"description": "Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the product rate plan charge.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the product rate plan charge was created.\n"
},
"description": {
"type": "string",
"description": "Description of the product rate plan charge.\n"
},
"drawdownUom": {
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled.\n\n\nUnit of measurement for a [drawdown\ncharge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).\n"
},
"isCommitted": {
"type": "boolean",
"description": "Indicates whether the charge is commited.\n"
},
"maxQuantity": {
"type": "number",
"description": "The maximum number of units for this charge. This field and the `minQuantity` field can be used to create a range of units allowed in a product rate plan charge.\n"
},
"minQuantity": {
"type": "number",
"description": "The minimum number of units for this charge. This field and the `maxQuantity` field can be used to create a range of units allowed in a product rate plan charge.\n"
},
"ratingGroup": {
"type": "string",
"nullable": true,
"description": "Specifies a rating group based on which usage records are rated.\n\nPossible values:\n\n- `ByBillingPeriod` (default): The rating is based on all the usages in a billing period.\n- `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. \n- `ByUsageRecord`: The rating is based on each usage record.\n- `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`).\n- `ByGroupId`: The rating is based on all the usages in a custom group.\n\n**Note:** \n- The `ByBillingPeriod` value can be applied for all charge models. \n- The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. \n- The `ByGroupId` value is only available if you have the Active Rating feature enabled.\n- Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`.\n"
},
"upToPeriods": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Specifies the length of the period during which the charge is active.\nIf this period ends before the subscription ends, the charge ends when\nthis period ends.\n\nIf the subscription end date is subsequently changed through a\nRenewal, or Terms and Conditions amendment, the charge end date will\nchange accordingly up to the original period end.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the product rate plan charge.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the product rate plan charge was last updated.\n"
},
"billCycleDay": {
"type": "integer",
"format": "int64",
"maximum": 31,
"minimum": 1,
"description": "Sets the bill cycle day (BCD) for the charge. The BCD determines which\nday of the month customer is billed. The BCD value in the account can\noverride the BCD in this object.\n"
},
"creditOption": {
"enum": [
"TimeBased",
"ConsumptionBased",
"FullCreditBack"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled.\n\n\nThe way to calculate credit. See [Credit\nOption](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)\nfor more information. \n"
},
"drawdownRate": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).\n"
},
"triggerEvent": {
"enum": [
"ContractEffective",
"ServiceActivation",
"CustomerAcceptance",
"SpecificDate"
],
"type": "string",
"description": "Specifies when to start billing the customer for the charge.\n\nValues: one of the following:\n- `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.\n- `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access.\n- `CustomerAcceptance` is when the customer accepts the services or products for a subscription. \n- `SpecificDate` is the date specified.\n"
},
"billCycleType": {
"enum": [
"DefaultFromCustomer",
"SpecificDayofMonth",
"SubscriptionStartDay",
"ChargeTriggerDay",
"SpecificDayofWeek",
"TermStartDay",
"TermEndDay"
],
"type": "string",
"description": "Specifies how to determine the billing day for the\ncharge. \n"
},
"billingPeriod": {
"enum": [
"Month",
"Quarter",
"Annual",
"Semi-Annual",
"Specific Months",
"Subscription Term",
"Week",
"Specific Weeks",
"Specific Days"
],
"type": "string",
"description": "The billing period for the charge. The start day of the billing period\nis also called the bill cycle day (BCD).\n"
},
"billingTiming": {
"enum": [
"IN_ADVANCE",
"IN_ARREARS"
],
"type": "string",
"description": "The billing timing for this charge.\n"
},
"discountLevel": {
"enum": [
"rateplan",
"subscription",
"account",
null
],
"type": "string",
"nullable": true,
"description": "The application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge.\n"
},
"includedUnits": {
"type": "number",
"description": "Specifies the number of units in the base set of units.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year",
"Per_Specific_Months"
],
"type": "string",
"description": "The list price base for the product rate plan charge.\n\nThis field is only applicable for recurring charges.\n"
},
"rolloverApply": {
"enum": [
"ApplyFirst",
"ApplyLast"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the priority of rollover, which is either first or last.\n"
},
"accountingCode": {
"type": "string",
"maxLength": 100,
"description": "The accounting code for the charge. Accounting codes group\ntransactions that contain similar accounting attributes.\n"
},
"commitmentType": {
"enum": [
"UNIT",
"CURRENCY"
],
"type": "string",
"description": "**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage\" target=\"_blank\">Unbilled Usage</a> feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to `133` or higher. Otherwise, an error occurs. \n\nThis field defines the type of commitment. A prepaid charge can be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can only be `CURRENCY` type. For topup(recurring or one-time) charges, this field indicates what type of funds are created. \n* If UNIT, it will create a fund with given prepaidUom.\n* If CURRENCY, it will create a fund with the currency amount calculated in list price.\n \nFor drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges.\n"
},
"numberOfPeriod": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Specifies the number of periods to use when calculating charges in an overage smoothing charge model.\nThis field is ued when overage smoothing model is `RollingWindow` or `Rollover`.\n"
},
"smoothingModel": {
"type": "string",
"nullable": true,
"description": "Specifies the smoothing model for an overage smoothing charge model or\nan tiered with overage model, which is an advanced type of a usage\nmodel that avoids spikes in usage charges. If a customer's usage\nspikes in a single period, then an overage smoothing model eases\noverage charges by considering usage and multiple periods.\n\n\nOne of the following values shows which smoothing model will be\napplied to the charge when `Overage` or `Tiered with Overage` is used:\n\n\n- `RollingWindow` considers a number of periods to smooth usage. The\nrolling window starts and increments forward based on billing\nfrequency. When allowed usage is met, then period resets and a new\nwindow begins.\n\n- `Rollover` considers a fixed number of periods before calculating\nusage. The net balance at the end of a period is unused usage, which\nis carried over to the next period's balance.\n"
},
"applyDiscountTo": {
"enum": [
"ONETIME",
"RECURRING",
"USAGE",
"ONETIMERECURRING",
"ONETIMEUSAGE",
"RECURRINGUSAGE",
"ONETIMERECURRINGUSAGE",
null
],
"type": "string",
"nullable": true,
"description": "Indicates which type of charge the discount charge applies to.\n"
},
"defaultQuantity": {
"type": "number",
"nullable": true,
"description": "The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n"
},
"discountClassId": {
"type": "string",
"nullable": true,
"description": "ID of the class the discount belongs to. The discount class defines the order in which discount product rate plan charges are applied.\n\nFor more information, see [Manage Discount Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).\n"
},
"prepaidQuantity": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).\n"
},
"productRatePlan": {
"type": "object",
"description": "EXPANDABLE.\nThe product rate plan that contains this product rate plan charge.\n"
},
"rolloverPeriods": {
"type": "integer",
"format": "int64",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the number of rollover periods, it is restricted to 3.\n"
},
"upToPeriodsType": {
"enum": [
"Billing_Periods",
"Days",
"Weeks",
"Months",
"Years",
null
],
"type": "string",
"nullable": true,
"description": "The period type used to define when the charge ends.\n"
},
"endDateCondition": {
"enum": [
"Subscription_End",
"One_Time",
"Fixed_Period",
"Specific_End_Date"
],
"type": "string",
"description": "The end date condition for this charge.\n"
},
"isStackedDiscount": {
"type": "boolean",
"description": "**Note**: This field is only applicable to the Discount - Percentage charge model.\n\nThis field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:\n - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.\n - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.\n\nFor more information, see [Stacked discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).\n"
},
"priceChangeOption": {
"enum": [
"NoChange",
"SpecificPercentageValue",
"UseLatestProductCatalogPricing"
],
"type": "string",
"default": "NoChange",
"nullable": true,
"description": "Applies an automatic price change when a termed subscription is\nrenewed and the following applies:\n\n\n1. AutomatedPriceChange setting is on\n\n2. Charge type is not one-time\n\n3. Charge model is not discount fixed amount\n"
},
"productRatePlanId": {
"type": "string",
"description": "The unique identifier of the product rate plan to which this product rate plan charge belongs.\n"
},
"deliveryScheduleId": {
"type": "string",
"description": "The unique identifier of the delivery schedule associated with the\nproduct rate plan charge. This field is applicable only when this charge is\nusing Delivery Pricing charge model.\n"
},
"validityPeriodType": {
"enum": [
"SUBSCRIPTION_TERM",
"ANNUAL",
"SEMI_ANNUAL",
"QUARTER",
"MONTH"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled.\n\n\nThe period in which the prepayment units are valid to use as defined\nin a [prepayment\ncharge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"weeklyBillCycleDay": {
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string",
"description": "Specifies which day of the week as the bill cycle day (BCD) for the\ncharge.\n\n\nThis feature is in **Limited Availability**. If you wish to have\naccess to the feature, submit a request at [Zuora Global\nSupport](http://support.zuora.com/). \n"
},
"prepaidOperationType": {
"enum": [
"topup",
"drawdown",
null
],
"type": "string",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe type of this charge. It is either a prepayment (topup) charge or a drawdown charge. \n"
},
"prepaidTotalQuantity": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"rolloverPeriodLength": {
"type": "integer",
"format": "int32",
"default": null,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period length of the rollover fund.\n"
},
"specificBillingPeriod": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "When the billing period is set to `Specific` Months then this positive\ninteger reflects the number of months for billing period charges.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "The number of months for the list price base of the charge. The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.\n"
},
"billingPeriodAlignment": {
"enum": [
"AlignToCharge",
"AlignToSubscriptionStart",
"AlignToTermStart",
"AlignToTermEnd"
],
"type": "string",
"description": "The billing period alignment setting for this charge.\n"
},
"deferredRevenueAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the deferred revenue account for this charge.\n\n\nThis feature is in **Limited Availability**. If you wish to have\naccess to the feature, submit a request at [Zuora Global\nSupport](http://support.zuora.com/). \n"
},
"legacyRevenueReporting": {
"type": "boolean",
"description": "Indicates whether to use the legacy revenue reporting for this charge.\n"
},
"revRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate",
null
],
"type": "string",
"nullable": true,
"maxLength": 22,
"description": "Specifies when revenue recognition begins.\n"
},
"priceIncreasePercentage": {
"type": "number",
"maximum": 100,
"minimum": -100,
"nullable": true,
"description": "Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the `PriceChangeOption` value to `SpecificPercentageValue`.\n\n1. AutomatedPriceChange setting is on\n2. Charge type is not one-time\n3. Charge model is not discount fixed amount\n\nValues: a decimal between -100 and 100\n"
},
"usageRecordRatingOption": {
"type": "string",
"nullable": true,
"description": "Determines how Zuora processes usage records for per-unit usage\ncharges. \n"
},
"overageCalculationOption": {
"enum": [
"EndOfSmoothingPeriod",
"PerBillingPeriod",
null
],
"type": "string",
"nullable": true,
"description": "Value specifies when to calculate overage charges.\n"
},
"recognizedRevenueAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the recognized revenue account for this charge.\n - Required when the Allow Blank Accounting Code setting is No.\n - Optional when the Allow Blank Accounting Code setting is Yes.\n\nThis 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"
},
"priceUpsellQuantityStacked": {
"type": "boolean",
"description": "Indicates whether the price upsell quantity is stacked.\n"
},
"productRatePlanChargeTiers": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe product rate plan charge tiers contained in this product rate plan charge.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"productRatePlanChargeNumber": {
"type": "string",
"description": "The natural key of the product rate plan charge.\n"
},
"contractAssetAccountingCodeId": {
"type": "string",
"description": "The type associated with the contract asset accounting code. \n\n\n**Note**: This field is only available if you have the Zuora Billing -\nRevenue Integration feature enabled.\n"
},
"overageUnusedUnitsCreditOption": {
"enum": [
"NoCredit",
"CreditBySpecificRate"
],
"type": "string",
"nullable": true,
"description": "Determines whether to credit the customer with unused units of usage.\n"
},
"useTenantDefaultForPriceChange": {
"type": "boolean",
"description": "Shows the tenant-level percentage uplift value for an automatic price\nchange to a termed subscription's renewal. You set the tenant uplift\nvalue in the web-based UI: **Settings > Billing > Define Default\nSubscription Settings**.\n"
},
"deferredRevenueAccountingCodeId": {
"type": "string",
"nullable": true,
"description": "The type associated with the deferred revenue accounting code, such as\nDeferred Revenue. \n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "The type of the accounting code for accounts receivable.\n"
},
"adjustmentRevenueAccountingCodeId": {
"type": "string",
"description": "The type associated with the adjustment revenue accounting code. \n\n\n**Note**: This field is only available if you have the Zuora Billing -\nRevenue Integration feature enabled.\n"
},
"contractLiabilityAccountingCodeId": {
"type": "string",
"description": "The accounting code for contract liability. \n\n\n**Note**: This field is only available if you have the Zuora Billing -\nRevenue Integration feature enabled.\n"
},
"recognizedRevenueAccountingCodeId": {
"type": "string",
"description": "The accounting code for recognized revenue, such as Monthly Recurring\nCharges or Overage Charges. \n"
},
"useDiscountSpecificAccountingCode": {
"type": "boolean",
"nullable": true,
"description": "Determines whether to define a new accounting code for the new\ndiscount charge.\n"
},
"adjustmentLiabilityAccountingCodeId": {
"type": "string",
"description": "The type associated with the adjustment liability accounting code. \n\n\n**Note**: This field is only available if you have the Zuora Billing -\nRevenue Integration feature enabled.\n"
},
"unbilledReceivablesAccountingCodeId": {
"type": "string",
"nullable": true,
"description": "The accounting code for unbilled receivables. \n\n\n**Note**: This field is only available if you have the Zuora Billing -\nRevenue Integration feature enabled.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related rate plan charges and order line items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.\n"
},
"contractRecognizedRevenueAccountingCodeId": {
"type": "string",
"description": "The accounting code for contract recognized revenue. \n\n\n**Note**: This field is only available if you have the Zuora Billing -\nRevenue Integration feature enabled.\n"
}
}
}
NestedPrpcTierOnExpand
{
"type": "object",
"title": "QueryProductRatePlanChargeTierResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the product rate plan charge tier.\n"
},
"tier": {
"type": "integer",
"format": "int32",
"description": "A unique number that identifies the tier that the price applies to.\n"
},
"price": {
"type": "number",
"format": "double",
"description": "The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.\n"
},
"active": {
"type": "boolean",
"description": "Indicates whether the product rate plan charge tier is active.\n"
},
"currency": {
"type": "string",
"description": "The valid code corresponding to the currency for the tier's price.\n"
},
"isDefault": {
"type": "boolean",
"description": "Indicates whether the tier is the default tier. The default tier is the\ntier that is used when the usage does not fall into any of the defined\ntiers.\n"
},
"endingUnit": {
"type": "number",
"description": "The end number of a range of units for the tier. This field is\napplicable for charges based on the Tiered Pricing or Tiered with\nOverage Pricing charge model.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the product rate plan charge tier.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The time that the product rate plan charge tier gets created in the system, in the\n`YYYY-MM-DD HH:MM:SS` format.\n"
},
"priceFormat": {
"enum": [
"FlatFee",
"PerUnit"
],
"type": "string",
"description": "Indicates if pricing is a flat fee or is per unit. This field is for tiered and volume pricing models only.\n\n**Note:** The values `Flat Fee` and `Per Unit` (with spaces) is valid for create or update calls.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the product rate plan charge tier.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the product rate plan charge tier was last updated.\n"
},
"overagePrice": {
"type": "number",
"format": "double",
"description": "Indicates whether the price is an overage price, which is the price when usage surpasses the last defined tier.\n"
},
"startingUnit": {
"type": "number",
"description": "The starting number of a range of units for the tier. This field is\napplicable for charges based on the Tiered Pricing or Tiered with\nOverage Pricing charge model.\n"
},
"includedUnits": {
"type": "number",
"description": "Specifies the number of units in the base set of units.\n"
},
"discountAmount": {
"type": "number",
"format": "double",
"description": "The specific amount for a fixed discount. This field is applicable for charges based on the Discount-Fixed Amount charge model.\n"
},
"discountPercentage": {
"type": "number",
"format": "double",
"description": "The percentage of discount for a percentage discount. This field is applicable for charges based on the Discount-Percentage charge model.\n"
},
"productRatePlanCharge": {
"type": "object",
"description": "EXPANDABLE.\nThe product rate plan charge that contains this product rate plan charge tier.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The unique identifier of the product rate plan charge that the tier\nbelongs to.\n"
},
"productChargeDefinitionId": {
"type": "string",
"description": "The unique identifier of the product rate plan charge definition that\nthe tier belongs to.\n"
}
}
}
NestedRatePlanChargeOnExpand
{
"type": "object",
"title": "QueryRatePlanChargeResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the rate plan charge.\n"
},
"mRR": {
"type": "number",
"description": "Monthly recurring revenue (MRR) is the amount of recurring\ncharges in a given month. The MRR calculation doesn't include one-time\ncharges nor usage charges. **Character limit**: 16 **Values**: automatically\ngenerated \n"
},
"tCV": {
"type": "number",
"format": "double",
"description": " The total contract value (TCV) is the value of a single rate plan charge in a subscription over the lifetime of the subscription. This value does not represent all charges on the subscription. The TCV includes recurring charges and one-time charges, but it doesn't include usage charge.\n**Character limit**: 16 **Values**: automatically generated "
},
"uOM": {
"type": "string",
"description": " Specifies the units to measure usage.\n**Character limit**: 25 **Values**: inherited from `ProductRatePlanCharge.UOM` "
},
"dMRC": {
"type": "number",
"description": "A delta monthly recurring charge is the change in monthly\nrecurring revenue caused by an amendment or a new subscription. \n\n**Character limit**: 16 \n\n**Values**: automatically generated\n"
},
"dTCV": {
"type": "number",
"description": "After an Amendment, the change in the total contract value\\\n\\ (TCV) amount for this charge, compared with its previous value.\n\n**Character limit**: 16\n\n**Values**: automatically generated \n"
},
"name": {
"type": "string",
"description": "The name of the rate plan charge. **Character limit**: 100\n**Values**: automatically generated \n"
},
"segment": {
"type": "integer",
"format": "int32",
"description": "The identifying number of the subscription rate plan segment. Segments are numbered sequentially, starting with 1.\n**Character limit**: 2 **Values**: automatically generated "
},
"version": {
"type": "integer",
"format": "int64",
"description": "The version of the rate plan charge. Each time a charge is amended, Zuora creates a new version of the rate plan charge. **Character limit**: 5 **Values**: automatically generated."
},
"quantity": {
"type": "number",
"description": " The default quantity of units, such as the number of authors in a hosted wiki service. Valid for all charge models except for Flat Fee pricing.\n**Character limit**: 16 **Values**: a valid quantity value "
},
"ratePlan": {
"type": "object",
"description": "EXPANDABLE.\nThe rate plan to which this charge belongs.\n"
},
"isPrepaid": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled.\n\n\nIndicates whether this charge is a prepayment (topup) charge or a\ndrawdown charge. \n"
},
"chargeType": {
"type": "string",
"description": "Specifies the type of charge.\n\n**Values**: inherited from `ProductRatePlanCharge.ChargeType`\n"
},
"isRollover": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nIt determines whether the rollover fields are needed.\n"
},
"originalId": {
"type": "string",
"description": "The original ID of the rate plan charge. **Character limit**: 32 **Values**: automatically generated "
},
"prepaidUOM": {
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nUnit of measurement for a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"ratePlanId": {
"type": "string",
"description": "The unique identifier of the rate plan to which this rate plan charge belongs.\n"
},
"revRecCode": {
"type": "string",
"description": "Associates this product rate plan charge with a specific revenue recognition code.\n\n**Character limit**: 70\n\n**Values**: inherited from `ProductRatePlanCharge.RevRecCode` or a valid revenue recognition code\n\n**Note**: Unless overridden, this value changes if `ProductRatePlanCharge.RevRecCode` is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.RevRecCode` is updated. "
},
"chargeModel": {
"type": "string",
"description": "Determines how to evaluate charges. Charge models must be\\\n\\ individually activated in the web-based UI.\n\n**Values**: inherited from `ProductRatePlanCharge.ChargeModel` \n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the rate plan charge.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the rate plan charge was created.\n"
},
"description": {
"type": "string",
"description": "A description of the rate plan charge. \n"
},
"drawdownUom": {
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nUnit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).\n"
},
"isCommitted": {
"type": "boolean",
"description": "Indicates whether the rate plan charge is commited.\n"
},
"isProcessed": {
"type": "boolean",
"description": "Indicates whether the rate plan charge has been processed.\n"
},
"ratingGroup": {
"enum": [
"ByBillingPeriod",
"ByUsageStartDate",
"ByUsageRecord",
"ByUsageUpload",
"ByGroupId"
],
"type": "string",
"description": "A rating group based on which usage records are rated. Only applicable to Usage charges.\n\nPossible values:\n\n- `ByBillingPeriod`: The rating is based on all the usages in a billing period.\n- `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. \n- `ByUsageRecord`: The rating is based on each usage record.\n- `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`).\n- `ByGroupId`: The rating is based on all the usages in a custom group.\n\nFor more information, see [Usage rating by group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group).\n"
},
"triggerDate": {
"type": "string",
"format": "date",
"description": " The date when the charge becomes effective and billing begins, in `yyyy-mm-dd` format. This field is required if the `TriggerEvent` field value is `SpecificDate`.\n**Character limit**: 29 "
},
"upToPeriods": {
"type": "integer",
"format": "int64",
"description": "Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.\n\n**Character limit**: 5 \n\n**Values**: inherited from `ProductRatePlanCharge.UpToPeriods` **Note**:\n\n- You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is only applicable only when the `EndDateCondition` field is set to `FixedPeriod`.\n- You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment.\n- Use this field to override the value in `ProductRatePlanCharge.UpToPeriod`.\n- If you override the value in this field, enter a whole number between 0 and 65535, exclusive.\n- If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the rate plan charge.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the rate plan charge was last updated.\n"
},
"billCycleDay": {
"type": "integer",
"format": "int64",
"description": "Indicates the charge's billing cycle day (BCD), which is\\\n\\ when bill runs generate invoices for charges associated with the product\\\n\\ rate plan charge or the account. \n\n**Values**: inherited from `ProductRatePlanCharge.BillCycleDay` \n"
},
"chargeNumber": {
"type": "string",
"description": "A unique number that identifies the charge. This number is returned as a string.\n\n**Values**: one of the following:\n- automatically generated if left `null`\n- a unique number of 50 characters or fewer\n"
},
"creditOption": {
"enum": [
"TimeBased",
"ConsumptionBased",
"FullCreditBack"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. \n\nThe way to calculate credit. See [Credit Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option) for more information.\n"
},
"drawdownRate": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).\n"
},
"triggerEvent": {
"type": "string",
"description": "Specifies when to start billing the customer for the charge.\n**Note: **This field can be passed through the Subscribe and Amend calls and will override the default value set on the Product Rate Plan Charge.\n\n**Character limit**: 18 \n\n**Values**: inherited from `ProductRatePlanCharge.TriggerEvent` and can be one of the following values:\n\n- `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.\n- `ServiceActivation` is when the services or products for a subscription have been activated and the customers have access.\n- `CustomerAcceptance` is when the customer accepts the services or products for a subscription.\n- `SpecificDate` is valid only on the RatePlanCharge.\n"
},
"billCycleType": {
"type": "string",
"description": "Specifies how to determine the billing day for the charge.\\n\\\n\n**Values**: inherited from `ProductRatePlanCharge.BillCycleType`\\\n\\ **Note:** You can override the value inherited from the Product Rate\\\n\\ Plan Charge, but only when creating a new subscription or a New Product\\\n\\ amendment. \n"
},
"billingPeriod": {
"type": "string",
"description": "Allows billing period to be overridden on rate plan charge.\\n\\\n****Values**: **inherited from `ProductRatePlanCharge.BillingPeriod` **Note:**\\\n\\ You can override the value inherited from the Product Rate Plan Charge,\\\n\\ but only when creating a new subscription or a New Product amendment. \n"
},
"billingTiming": {
"enum": [
"In Advance",
"In Arrears"
],
"type": "string",
"description": "The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types.\n\n**Note:** You can override the value inherited from the Product Rate Plan Charge when a subscription has a recurring charge type.\n"
},
"discountLevel": {
"enum": [
"rateplan",
"subscription",
"account"
],
"type": "string",
"description": "Application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge.\n"
},
"isLastSegment": {
"type": "boolean",
"description": "Indicates if the segment of the rate plan charge is the most recent segment. **Character limit**: 5 **Values**: automatically generated."
},
"listPriceBase": {
"enum": [
"Per Billing Period",
"Per Month",
"Per Week",
"Per Year",
"Per Specific Months"
],
"type": "string",
"description": "The list price base for the product rate plan charge.\n"
},
"rolloverApply": {
"enum": [
"ApplyFirst",
"ApplyLast"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the priority of rollover, which is either first or last.\n"
},
"accountingCode": {
"type": "string",
"description": "The accounting code for the charge. Accounting codes group\\\n\\ transactions that contain similar accounting attributes.\n\n**Values**: inherited from `ProductRatePlanCharge.AccountingCode`\\n\\\n\\n**Note**: This value changes if `ProductRatePlanCharge.AccountingCode`\\\n\\ is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge`\\\n\\ do not change when `ProductRatePlanCharge.AccountingCode` is updated. \n"
},
"commitmentType": {
"enum": [
"UNIT",
"CURRENCY"
],
"type": "string",
"description": "**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage\" target=\"_blank\">Unbilled Usage</a> feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to `133` or higher. Otherwise, an error occurs. \n\nThis field defines the type of commitment. A prepaid charge can be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can only be `CURRENCY` type. For topup(recurring or one-time) charges, this field indicates what type of funds are created. \n* If UNIT, it will create a fund with given prepaidUom.\n* If CURRENCY, it will create a fund with the currency amount calculated in list price.\n \nFor drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges.\n"
},
"invoiceOwnerId": {
"type": "string",
"description": "ID of the account that will pay the billing documents for the subscription.\n"
},
"subscriptionId": {
"type": "string",
"description": "The unique identifier of the subscription to which the rate plan charge belongs.\n"
},
"applyDiscountTo": {
"type": "string",
"description": "Specifies the type of charges a specific discount applies to. \n**Values**: inherited from `ProductRatePlanCharge.ApplyDiscountTo` \n"
},
"numberOfPeriods": {
"type": "integer",
"format": "int64",
"description": "Specifies the number of periods to use when calculating charges in an overage smoothing charge model. **Character limit**: 5 **Values**: inherited from `ProductRatePlanCharge.NumberOfPeriod` "
},
"prepaidQuantity": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).\n"
},
"prorationOption": {
"type": "string",
"description": "Determines how to prorate charges when a subscription is created or amended.\n"
},
"rolloverPeriods": {
"type": "integer",
"format": "int64",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the number of rollover periods, it is restricted to 3.\n"
},
"specificEndDate": {
"type": "string",
"format": "date",
"description": "The specific date on which the charge ends, in `yyyy-mm-dd` format.\n\n**Character limit**: 29 \n\n**Note**:\n\n- This field is only applicable when the `EndDateCondition` field is set to `SpecificEndDate`.\n- If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date.\n"
},
"upToPeriodsType": {
"enum": [
"Billing Periods",
"Days",
"Weeks",
"Months",
"Years"
],
"type": "string",
"default": "Billing Periods",
"description": "The period type used to define when the charge ends. This field can be updated when **Status** is `Draft`. \n\n**Note**:\n\n- You must use this field together with the `UpToPeriods` field to specify the time period.\n- This field is only applicable only when the `EndDateCondition` field is set to `FixedPeriod`.\n"
},
"amendedByOrderOn": {
"type": "string",
"format": "date",
"description": "The date when the rate plan charge is amended through an order\nor amendment. This field is to standardize the booking date\ninformation to increase audit ability and traceability of data\nbetween Zuora Billing and Zuora Revenue. It is mapped as the\nbooking date for a sale order line in Zuora Revenue.\n"
},
"effectiveEndDate": {
"type": "string",
"format": "date",
"description": "Start date when the rate plan charge becomes active, as `yyyy-mm-dd`.\n"
},
"endDateCondition": {
"enum": [
"Subscription_End",
"Fixed_Period",
"Specific_End_Date"
],
"type": "string",
"description": "Condition for the charge to become inactive.\n\n- If the value of this field is `Fixed_Period`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields.\n- If the value of this field is `Specific_End_Date`, use the `specificEndDate` field to specify the date when the charge becomes inactive.\n"
},
"invoiceScheduleId": {
"type": "string",
"description": "The unique identifier of the invoice schedule associated with the subscription.\n"
},
"originalOrderDate": {
"type": "string",
"format": "date",
"description": "The date when the rate plan charge is created through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sales order line in Zuora Revenue.\n"
},
"priceChangeOption": {
"type": "string",
"description": "Applies an automatic price change when a termed subscription is renewed.\n\n**Values**: one of the following:\n\n- `NoChange` (default)\n- `SpecificPercentageValue`\n- `UseLatestProductCatalogPricing`\n"
},
"chargedThroughDate": {
"type": "string",
"format": "date",
"maxLength": 29,
"description": "The date through which a customer has been billed for the charge.\n"
},
"effectiveStartDate": {
"type": "string",
"format": "date",
"description": "Final date the rate plan is active, as `yyyy-mm-dd`.\n"
},
"numberOfDeliveries": {
"type": "number",
"description": "Number of deliveries in the billing period for the charge segment.\n\nThe `numberOfDeliveries` is used for the Delivery Pricing charge model only. \n\n**Note**: The Delivery Pricing charge model 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. You can check **Delivery Pricing** in **Billing Settings** > **Enable Charge Types / Models**.\n"
},
"validityPeriodType": {
"enum": [
"SUBSCRIPTION_TERM",
"ANNUAL",
"SEMI_ANNUAL",
"QUARTER",
"MONTH"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"weeklyBillCycleDay": {
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string",
"description": "Specifies which day of the week as the bill cycle day (BCD) for the charge.\n"
},
"subscriptionOwnerId": {
"type": "string",
"description": "ID of the account that owns the subscription.\n"
},
"prepaidOperationType": {
"enum": [
"topup",
"drawdown",
null
],
"type": "string",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe type of this charge. It is either a prepayment (topup) charge or a drawdown charge. \n"
},
"prepaidTotalQuantity": {
"type": "number",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"processedThroughDate": {
"type": "string",
"format": "date",
"description": " The date until when charges have been processed. When billing in arrears, such as usage, this field value is the the same as the `ChargedThroughDate` value. This date is the earliest date when a charge can be amended.\n**Character limit**: 29 **Values**: automatically generated "
},
"rolloverPeriodLength": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period length of the rollover fund.\n"
},
"productRatePlanCharge": {
"type": "object",
"description": "EXPANDABLE.\nThe product rate plan charge associated with this rate plan charge.\n"
},
"specificBillingPeriod": {
"type": "integer",
"format": "int64",
"description": "Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to `Specific Months` or `Specific Weeks`.\n**Character limit**: 5 **Values**: inherited from `ProductRatePlanCharge.BillingPeriod` **Note:** You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment. "
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"nullable": true,
"description": "The number of months for the list price base of the charge. This field is required if you set the value of the `ListPriceBase` field to `Per Specific Months`.\n\n**Notes**: \n - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.\n"
},
"billingPeriodAlignment": {
"type": "string",
"description": "Aligns charges within the same subscription if multiple charges\\\n\\ begin on different dates.\n\n**Values**: inherited from `ProductRatePlanCharge.BillingPeriodAlignment` \n"
},
"revRecTriggerCondition": {
"type": "string",
"description": " Specifies when revenue recognition begins.\n\n**Character limit**: 22\n\n**Values**: inherited from `ProductRatePlanCharge.RevRecTriggerCondition` or one of the following:\n\n- `ContractEffectiveDate`\n\n- `ServiceActivationDate`\n\n- `CustomerAcceptanceDate`\n\nNote: Unless overridden, this value changes if `ProductRatePlanCharge.RevRecTriggerCondition` is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.RevRecTriggerCondition` is updated. "
},
"priceIncreasePercentage": {
"type": "number",
"format": "double",
"description": " Specifies the percentage to increase or decrease the price of renewed subscriptions.\n**Character limit**: 16 **Values**: a decimal value between -100 and 100 "
},
"productRatePlanChargeId": {
"type": "string",
"description": "The unique identifier of the product rate plan charge associated with this product rate plan charge.\n"
},
"overageCalculationOption": {
"type": "string",
"description": "Determines when to calculate overage charges. If the value of the SmoothingMode field is null (not specified and not inherited from ProductRatePlanCharge.SmoothingMode), the value of this field is ignored. **Character limit**: 20 **Values**: inherited from `ProductRatePlanCharge.OverageCalculationOption` "
},
"productChargeDefinitionId": {
"type": "string",
"description": "The unique ID of the product charge definition.\n"
},
"priceUpsellQuantityStacked": {
"type": "boolean"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": " Specifies the Revenue Recognition Rule that you want the Rate Plan Charge to use. This field can be updated when **Status** is `Draft`. By default, the Revenue Recognition Rule is inherited from the Product Rate Plan Charge. For Amend calls, you can use this field only for NewProduct amendments. For Update calls, you can use this field only to update subscriptions in draft status. Note that if you use this field to specify a Revenue Recognition Rule for the Rate Plan Charge, the rule will remain as specified even if you later change the rule used by the corresponding Product Rate Plan Charge.\n\n**Character limit**: n/a\n\n**Values**: inherited from `ProductRatePlanCharge.RevenueRecognitionRuleName` or the name of an active Revenue Recognition Rule\n\n**Note**: Unless overridden, this value changes if `ProductRatePlanCharge.RevenueRecognitionRuleName` is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.RevenueRecognitionRuleName` is updated. "
},
"applyToBillingPeriodPartially": {
"type": "boolean",
"description": "Allow the discount duration to be aligned with the billing period partially.\n\n**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.\n"
},
"overageUnusedUnitsCreditOption": {
"type": "string",
"description": " Determines whether to credit the customer with unused units of usage.\n**Character limit**: 20 **Values**: inherited from `ProductRatePlanCharge.OverageUnusedUnitsCreditOption` "
},
"deferredRevenueAccountingCodeId": {
"type": "string",
"description": "ID of the deferredRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> and <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a> features are enabled.\n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "ID of the accountReceivableAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a>, <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a>, and <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Get_started_with_Invoice_Settlement/AA_Overview_of_Invoice_Settlement\" target=\"_blank\">Invoice Settlement</a> features are enabled.\n"
},
"recognizedRevenueAccountingCodeId": {
"type": "string",
"description": "ID of the recognizedRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> and <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a> features are enabled.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\nIf both the following features in <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing\" target=\"_blank\">Advanced Consumption Billing</a> are enabled in your tenant, you must ensure the `excludeItemBillingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the `excludeItemBookingFromRevenueAccounting` field in an Create Subscription or Add Product order action is set to `false`, you must also set the `excludeItemBillingFromRevenueAccounting` field in this order action to `false`.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charges from revenue accounting.\n\nIf both the following features in <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing\" target=\"_blank\">Advanced Consumption Billing</a> are enabled in your tenant, you must ensure the `excludeItemBookingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
}
}
}
NestedRatePlanOnExpand
{
"type": "object",
"title": "QueryRatePlanResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the rate plan.\n"
},
"name": {
"type": "string",
"description": "The name of the rate plan.\n"
},
"productId": {
"type": "string",
"description": "The unique identifier of the product associated with the rate plan.\n"
},
"amendmentId": {
"type": "string",
"description": "The unique identifier of the amendment made to the subscription.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the rate plan.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the rate plan was created.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the rate plan.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the rate plan was last updated.\n"
},
"subscription": {
"type": "object",
"description": "EXPANDABLE.\nThe subscription associated with the rate plan.\n"
},
"amendmentType": {
"type": "string",
"description": "The type of amendment associated with the rate plan. This field only applies to amendment rate plans.\n"
},
"invoiceOwnerId": {
"type": "string",
"description": "The unique identifier of the account that will pay the invoice.\n"
},
"subscriptionId": {
"type": "string",
"description": "The unique identifier of the subscription associated with the rate plan.\n"
},
"productRatePlan": {
"type": "object",
"description": "EXPANDABLE.\nThe product rate plan associated with the rate plan.\n"
},
"ratePlanCharges": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe rate plan charges on the rate plan.\n"
},
"productRatePlanId": {
"type": "string",
"description": "The unique identifier of the product rate plan that the rate plan is based on.\n"
},
"originalRatePlanId": {
"type": "string",
"description": "The original ID of the subscription rate plan, which is the ID of the subscription rate plan in the version-1 subscription.\n"
},
"subscriptionOfferId": {
"type": "string",
"description": "The unique identifier of the subscription offer associated with the rate plan.\n"
},
"subscriptionOwnerId": {
"type": "string",
"description": "The unique identifier of the account that owns the subscription.\n"
},
"externallyManagedPlanId": {
"type": "string",
"description": "Indicates the unique identifier for the rate plan purchased on a\nthird-party store. This field is used to represent a subscription rate\nplan created through third-party stores.\n"
},
"subscriptionRatePlanNumber": {
"type": "string",
"description": "The number of the rate plan in the subscription.\n"
}
}
}
NestedRefundApplicationItemOnExpand
{
"type": "object",
"title": "QueryRefundApplicationItemResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the refund application item.\n"
},
"amount": {
"type": "number",
"description": "The amount of the refund application item.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the refund application item.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund application item was created.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the refund application item.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund application item was last updated.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the refund application item becomes effective.\n"
},
"journalEntryId": {
"type": "string",
"description": "The ID of the journal entry that corresponds to this transaction.\n"
},
"creditMemoItemId": {
"type": "string",
"description": "The unique identifier of the credit memo item to which the refund application item is applied.\n"
},
"refundApplication": {
"type": "object",
"description": "EXPANDABLE. The refund application object that contains the refund application item.\n"
},
"applicationGroupId": {
"type": "string",
"description": "The ID of the application group to which this refund application belongs.\n"
},
"refundApplicationId": {
"type": "string",
"description": "The ID of the refund application to which this refund application item belongs.\n"
},
"cashAccountingCodeId": {
"type": "string",
"description": "The accounting code for cash payments.\n"
},
"creditTaxationItemId": {
"type": "string",
"description": "The unique identifier of the credit taxation item to which the refund application item is applied.\n"
},
"onAccountAccountingCodeId": {
"type": "string",
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"unappliedPaymentAccountingCodeId": {
"type": "string",
"description": "The accounting code for the unapplied payment.\n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "The Account Receivable accounting code of a standalone charge.\n"
}
}
}
NestedRefundApplicationOnExpand
{
"type": "object",
"title": "QueryRefundApplicationResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the refund application.\n"
},
"refund": {
"type": "object",
"description": "EXPANDABLE.\nThe refund associated with the refund application.\n"
},
"payment": {
"type": "object",
"description": "EXPANDABLE.\nThe payment associated with the refund application.\n"
},
"refundId": {
"type": "string",
"description": "The unique identifier of the refund associated with the refund application.\n"
},
"accountId": {
"type": "string",
"description": "The unique identifier of the account.\n"
},
"invoiceId": {
"type": "string",
"description": "The unique identifier of the invoice to which the associated payment was applied.\n"
},
"paymentId": {
"type": "string",
"description": "The unique identifier of the payment associated with the refund application.\n"
},
"applyAmount": {
"type": "number",
"format": "double",
"description": "The total amount of the refund to be applied.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the refund application.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund application was created.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the refund application.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund application was last updated.\n"
},
"creditMemoId": {
"type": "string",
"description": "The unique identifier of the credit memo to which the associated payment was applied.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the refund application becomes effective.\n"
},
"journalEntryId": {
"type": "string",
"description": "The ID of the journal entry that corresponds to this transaction.\n"
},
"applicationGroupId": {
"type": "string",
"description": "The ID of the application group to which this payment application belongs.\n"
},
"cashAccountingCodeId": {
"type": "string",
"description": "The accounting code for cash payments.\n"
},
"refundApplicationItems": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe refund application items contained in the refund application.\n"
},
"onAccountAccountingCodeId": {
"type": "string",
"description": "The accounting code that maps to an on account in your accounting\nsystem.\n"
},
"unappliedPaymentAccountingCodeId": {
"type": "string",
"description": "The accounting code for the unapplied payment.\n"
},
"accountReceivableAccountingCodeId": {
"type": "string",
"description": "The Account Receivable accounting code of a standalone charge.\n"
}
}
}
NestedRefundOnExpand
{
"type": "object",
"title": "QueryRefundResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the refund.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the refund. \n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the refund.\n"
},
"status": {
"enum": [
"Processed",
"Canceled",
"Error",
"Processing"
],
"type": "string",
"description": "The status of the refund. \n"
},
"account": {
"type": "object",
"description": "EXPANDABLE.\nThe account associated with the refund.\n"
},
"comment": {
"type": "string",
"description": "Comments about the refund.\n"
},
"gateway": {
"type": "string",
"description": "The gateway that processed the original payment. A gateway is an online service provider that connects an online shopping cart to a payment processor.\nZuora uses this same gateway for the corresponding refund. \nIf this payment gateway is no longer active, then the electronic refund fails. \n"
},
"currency": {
"type": "string",
"description": "The currency of the refund.\n"
},
"payoutId": {
"type": "string",
"description": "The payout ID of the refund from the gateway side.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment or credit memo.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways.\n"
},
"methodType": {
"enum": [
"ACH",
"Cash",
"Check",
"CreditCard",
"PayPal",
"WireTransfer",
"DebitCard",
"CreditCardReferenceTransaction",
"BankTransfer",
"Other"
],
"type": "string",
"description": "How an external refund was issued to a customer. \n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction.\n"
},
"refundDate": {
"type": "string",
"format": "date",
"description": "The date when the refund takes effect, in `yyyy-mm-dd` format. For example, 2017-03-01.\n"
},
"sourceType": {
"enum": [
"Payment",
"CreditBalance"
],
"type": "string",
"description": "Specifies whether the refund is a refund payment or a credit balance. \n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the refund.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was created.\n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was submitted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the refund.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was last updated.\n"
},
"gatewayState": {
"enum": [
"MarkedForSubmission",
"Submitted",
"Settled",
"NotSubmitted",
"FailedToSettle"
],
"type": "string",
"description": "The status of the refund in the gateway. \n"
},
"refundNumber": {
"type": "string",
"description": "The number of the refund.\n"
},
"paymentMethod": {
"type": "object",
"description": "EXPANDABLE.\nThe payment method to which the refund is returned.\n"
},
"accountingCode": {
"type": "string",
"description": "The accounting code that maps to this refund transaction in your accounting\nsystem.\n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the refund. This\nmessage is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the refund.\n"
},
"refundApplications": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe refund applications associated with the refund.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the refund. This code\nis gateway-dependent.\n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways.\n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"refundTransactionTime": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot which is a copy of the particular payment method used in a transaction.\n"
},
"secondRefundReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"associatedTransactionNumber": {
"type": "string",
"description": "The number of the associated transactions, such as payments.\n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
}
NestedSubscriptionOnExpand
{
"type": "object",
"title": "QuerySubscriptionResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the subscription.\n"
},
"cMRR": {
"type": "number",
"description": "Monthly recurring revenue of the subscription.\n"
},
"name": {
"type": "string",
"description": "The name of the subscription.\n"
},
"notes": {
"type": "string",
"maxLength": 65535,
"description": "Additional information about the subscription.\n"
},
"rampId": {
"type": "string",
"description": "The ID of the ramp object associated with the subscription.\n\n**Note**: This field is available only if you have the <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Ramp\"\ntarget=\"_blank\">Ramp</a> feature enabled.\n"
},
"status": {
"enum": [
"Draft",
"Pending Activation",
"Pending Acceptance",
"Active",
"Cancelled",
"Suspended"
],
"type": "string",
"description": "Subscription status.\n"
},
"account": {
"type": "object",
"description": "EXPANDABLE.\nThe subscription owner account associated with the subscription.\n"
},
"version": {
"type": "integer",
"format": "int64",
"description": "This is the subscription version automatically generated by Zuora Billing. Each order or amendment creates a new version of the subscription, which incorporates the changes made in the order or amendment."
},
"currency": {
"type": "string",
"description": "The currency of the subscription.\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currencies</a> feature enabled.\n"
},
"revision": {
"type": "string",
"description": "An auto-generated decimal value uniquely tagged with a subscription.\nThe value always contains one decimal place, for example, the revision\nof a new subscription is 1.0. If a further version of the subscription\nis created, the revision value will be increased by 1. Also, the\nrevision value is always incremental regardless of deletion of\nsubscription versions.\n"
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN"
],
"type": "string",
"description": "The type of the subscription term.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with this subscription."
},
"autoRenew": {
"type": "boolean",
"default": false,
"description": "If `true`, the subscription automatically renews at the end of the\nterm. \n"
},
"ratePlans": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe rate plans associated with the subscription.\n"
},
"originalId": {
"type": "string",
"description": "The original rate plan charge ID. Only available for update\nsubscription.\n"
},
"prepayment": {
"type": "boolean",
"description": "Whether the subscription is prepaid.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the subscription.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the subscription was created in the Zuora\nsystem, in the `yyyy-mm-dd hh:mm:ss` format.\n"
},
"currentTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the current subscription term.\n"
},
"initialTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the initial subscription term.\n"
},
"paymentTerm": {
"type": "string",
"description": "Name of the payment term associated with the account. For example,\n\"Net 30\". The payment term determines the due dates of invoices.\n"
},
"renewalTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the subscription renewal term.\n"
},
"termEndDate": {
"type": "string",
"format": "date",
"description": "Date the subscription term ends. If the subscription is evergreen,\nthis is null or is the cancellation date (if one has been set).\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the subscription.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the subscription was last updated, in the `yyyy-mm-dd hh:mm:ss` format.\n"
},
"cancelReason": {
"type": "string",
"description": "The reason for a subscription cancellation copied from the\n`changeReason` field of a Cancel Subscription order action. \n\nThis field contains valid value only if a subscription is cancelled\nthrough the Orders UI or API. Otherwise, the value for this field will\nalways be `null`.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPANDABLE.\nThe invoice items associated with the subscription.\n"
},
"invoiceOwner": {
"type": "object",
"description": "EXPANDABLE.\nThe invoice owner account associated with the subscription.\n"
},
"billToContact": {
"type": "object",
"description": "EXPANDABLE.\nThe bill-to contact who pays the billing documents for this subscription.\n"
},
"cancelledDate": {
"type": "string",
"format": "date",
"description": "The date on which the subscription was canceled.\n"
},
"quoteType__QT": {
"type": "string",
"maxLength": 32,
"description": "The Quote type that represents the subscription lifecycle stage such as\nNew, Amendment, Renew or Cancel. This field is used in Zuora data sources\nto report on Subscription metrics. If the subscription originated from\nZuora Quotes, the value is populated with the value from Zuora Quotes.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"termStartDate": {
"type": "string",
"format": "date",
"description": "Date the subscription term begins. If this is a renewal subscription,\nthis date is different from the subscription start date.\n"
},
"invoiceOwnerId": {
"type": "string",
"description": "The account ID that owns the invoices associated with the subscription. \n"
},
"renewalSetting": {
"enum": [
"RENEW_WITH_SPECIFIC_TERM",
"RENEW_TO_EVERGREEN"
],
"type": "string",
"default": "RENEW_WITH_SPECIFIC_TERM",
"description": "Specifies whether a termed subscription will remain `TERMED` or change to `EVERGREEN` when it is renewed. \n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact for the subscription.\n"
},
"isLatestVersion": {
"type": "boolean",
"description": "If `true`, the current subscription object is the latest version.\n"
},
"lastBookingDate": {
"type": "string",
"format": "date",
"description": "The last booking date of the subscription object. This field is\nwritable only when the subscription is newly created as a first\nversion subscription. You can override the date value when creating a\nsubscription through the Subscribe and Amend API or the subscription\ncreation UI (non-Orders). Otherwise, the default value `today` is set\nper the user's timezone. The value of this field is as follows:\n\n* For a new subscription created by the [Subscribe and Amend\nAPIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate),\nthis field has the value of the subscription creation date.\n\n* For a subscription changed by an amendment, this field has the value\nof the amendment booking date.\n\n* For a subscription created or changed by an order, this field has\nthe value of the order date. \n"
},
"quoteNumber__QT": {
"type": "string",
"maxLength": 32,
"description": "The unique identifier of the Quote. This field is used in Zuora data\nsources to report on Subscription metrics. If the subscription originated\nfrom Zuora Quotes, the value is populated with the value from Zuora\nQuotes.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact for the subscription.\n"
},
"creatorAccountId": {
"type": "string",
"description": "The ID of the account that created the subscription. This field is\nautomatically populated with the ID of the account that creates the\nsubscription.\n"
},
"invoiceScheduleId": {
"type": "string",
"description": "The ID of the invoice schedule associated with the subscription.\n\n\nIf multiple invoice schedules are created for different terms of a\nsubscription, this field stores the latest invoice schedule.\n\n\n**Note**: This field is available only if you have the <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule\"\ntarget=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"isInvoiceSeparate": {
"type": "boolean",
"default": false,
"description": "Determines if the subscription is invoiced separately. \nIf `true`, then all charges for this subscription are collected into the subscription's own invoice.\n"
},
"cpqBundleJsonId__QT": {
"type": "string",
"maxLength": 32,
"description": "The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.\n"
},
"externallyManagedBy": {
"enum": [
"Amazon",
"Apple",
"Google",
"Roku"
],
"type": "string",
"description": "An enum field on the Subscription object to indicate the name of a\nthird-party store. This field is used to represent subscriptions created\nthrough third-party stores.\n"
},
"opportunityName__QT": {
"type": "string",
"maxLength": 100,
"description": "The unique identifier of the Opportunity. This field is used in Zuora data\nsources to report on Subscription metrics. If the subscription originated\nfrom Zuora Quotes, the value is populated with the value from Zuora\nQuotes.\n"
},
"originalCreatedDate": {
"type": "string",
"description": "The date when the subscription was originally created. \nThis value is the same as the `createdDate` value until the subscription is amended.\n"
},
"subscriptionEndDate": {
"type": "string",
"format": "date",
"description": "The date when the subscription term ends, where the subscription ends\nat midnight the day before.\n\nFor example, if the `subscriptionEndDate` is 12/31/2016, the\nsubscriptions ends at midnight (00:00:00 hours) on 12/30/2016.\n\nThis date is the same as the term end date or the cancelation date, as\nappropriate.\n"
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the subscription is activated, in the `yyyy-mm-dd` format.\n\n\nYou must specify a Service Activation date if the Customer Acceptance\ndate is set. If the Customer Acceptance date is not set, the value of\nthe `serviceActivationDate` field defaults to be the Contract\nEffective Date.\n\n\nThe billing trigger dates must follow this rule:\n\n\ncontractEffectiveDate <= serviceActivationDate <=\ncontractAcceptanceDate\n"
},
"creatorInvoiceOwnerId": {
"type": "string",
"description": "The account ID that owns the invoices associated with the subscription or the amended subscription.\n"
},
"currentTermPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"default": "Month",
"description": "The period type for the current subscription term.\n"
},
"initialTermPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"default": "Month",
"description": "The period type for the first subscription term.\n"
},
"quoteBusinessType__QT": {
"type": "string",
"maxLength": 32,
"description": "The specific identifier for the type of business transaction the Quote\nrepresents such as New, Upsell, Downsell, Renewal or Churn. This field is\nused in Zuora data sources to report on Subscription metrics. If the\nsubscription originated from Zuora Quotes, the value is populated with the\nvalue from Zuora Quotes.\n"
},
"renewalTermPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"default": "Month",
"description": "The period type for the subscription renewal term.\n"
},
"serviceActivationDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been activated and access has been provided to the customer, in the `yyyy-mm-dd` format.\n"
},
"subscriptionStartDate": {
"type": "string",
"format": "date",
"description": "Date the subscription becomes effective.\n"
},
"contractAcceptanceDate": {
"type": "string",
"format": "date",
"description": "The date when the customer accepts the contract, in the `yyyy-mm-dd` format.\n\nIf this field is not set:\n\n- If the `serviceActivationDate` field is not set, the value of this\nfield is set to be the contract effective date.\n\n- If the `serviceActivationDate` field is set, the value of this field\nis set to be the service activation date.\n\n\nThe billing trigger dates must follow this rule:\n\ncontractEffectiveDate <= serviceActivationDate <=\ncontractAcceptanceDate\n"
},
"previousSubscriptionId": {
"type": "string",
"description": "The ID of the previous subscription. This field is only available if\nthe subscription is a renewal subscription.\n"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot.\n"
},
"opportunityCloseDate__QT": {
"type": "string",
"format": "date"
},
"subscriptionVersionAmendmentId": {
"type": "string",
"description": "The ID of the amendment made to this subscription version.\n"
}
}
}
NestedUsageOnExpand
{
"type": "object",
"title": "QueryUsageResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the usage.\n"
},
"uOM": {
"type": "string",
"description": "The units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**.\n"
},
"fileId": {
"type": "string",
"description": "File ID of the uploaded usage records file. You can use this file ID with [Get files](https://developer.zuora.com/api-references/api/operation/GET_Files) to download the file.\n"
},
"account": {
"type": "object",
"description": "EXPANDABLE.\nThe account associated with the usage.\n"
},
"fileName": {
"type": "string",
"description": "The name of the import file when the usage record is imported from the file.\n"
},
"importId": {
"type": "string",
"description": "The unique identifier of the import.\n"
},
"quantity": {
"type": "number",
"description": "Number of units used.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the usage.\n"
},
"rbeStatus": {
"enum": [
"Importing",
"Pending",
"Processed"
],
"type": "string",
"description": "Indicates if the rating and billing engine (RBE) processed usage data for an invoice.\n"
},
"uniqueKey": {
"type": "string",
"description": "a customer-defined specific identifier of a usage record.\n\n**Note**: This field is only available if you have the [Prepaid with\nDrawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)\nfeature enabled. See [Upload usage record with unique\nkey](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Prepaid_balance_transactions#Upload_usage_record_with_unique_key)\nfor more information.\n"
},
"sourceType": {
"enum": [
"API",
"Import"
],
"type": "string",
"description": "Indicates if the usage records were imported from the web-based UI or the API.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the usage.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the usage was created.\n"
},
"description": {
"type": "string",
"description": "A description of the usage record.\n"
},
"endDateTime": {
"type": "string",
"format": "date-time",
"description": "End date of the time period in which usage is tracked. Zuora uses\nthis field value to determine the usage date.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the usage.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the usage was last updated.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account associated with the usage.\n"
},
"startDateTime": {
"type": "string",
"format": "date-time",
"description": "Start date of the time period in which usage is tracked. Zuora uses\nthis field value to determine the usage date.\n"
},
"subscriptionId": {
"type": "string",
"description": "The original ID of the subscription that contains the fees related to the usage data.\n"
},
"ratePlanChargeId": {
"type": "string",
"description": "ID of the rate plan charge that pays for this usage.\n"
},
"submissionDateTime": {
"type": "string",
"format": "date-time",
"description": "The date and time when the usage was submitted.\n"
}
}
}
NestedValidityPeriodSummaryOnExpand
{
"type": "object",
"title": "QueryValidityPeriodSummaryResponse",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the validity period summary.\n"
},
"uom": {
"type": "string",
"description": "The UOM of the validity period.\n"
},
"account": {
"type": "object",
"description": "EXPANDABLE.\nThe account associated with the validty period summary.\n"
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date of the validity period.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account to which the prepaid balance belongs.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the validity period.\n"
},
"createdById": {
"type": "string",
"description": "The unique identifier of the user who created the validity period summary.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the validity period summary was created.\n"
},
"updatedById": {
"type": "string",
"description": "The unique identifier of the user who last updated the validity period summary.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the validity period summary was last updated.\n"
},
"totalBalance": {
"type": "number",
"description": "The total prepaid balance for the current validity period.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the account to which the prepaid balance belongs.\n"
},
"prepaidBalance": {
"type": "object",
"description": "EXPANDABLE.\nThe prepaid balance associated with the validity period summary.\n"
},
"prepaidBalanceId": {
"type": "string",
"description": "The unique identifier of the prepaid balance.\n"
},
"remainingBalance": {
"type": "number",
"description": "The remaining prepaid balance for the current validity period.\n"
},
"totalBilledAmount": {
"type": "number"
},
"overageRatedAmount": {
"type": "number",
"format": "double",
"description": "The overage rated amount for the validity period.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "The number of the subscription the validity period belongs to.\n"
},
"billedBalanceAmount": {
"type": "number"
},
"overageRatedQuantity": {
"type": "number",
"format": "double",
"description": "The overage rated quantity for the validity period.\n"
}
}
}
NextRunResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the bill run.\n"
},
"status": {
"enum": [
"Pending",
"Processing",
"Completed",
"Error",
"Canceled",
"Posted",
"PostInProgress",
"CancelInProgress",
"RemoveInProgress",
"Paused"
],
"type": "string",
"description": "The status of the bill run.\n"
},
"batches": {
"type": "array",
"items": {
"type": "string"
},
"description": "The batch of accounts for this bill run. \n\n**Values:** `AllBatches` or an array of `Batch`*n* where *n* is one of numbers 1 - 50, for example, `Batch7`.\n"
},
"autoPost": {
"type": "boolean",
"description": "Whether to automatically post the bill run after the bill run is created.\n"
},
"schedule": {
"$ref": "#/components/schemas/BillRunScheduleResponseType"
},
"autoEmail": {
"type": "boolean",
"description": "Whether to automatically send emails after Auto-Post is complete.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for this bill run, only valid for ad-hoc bill runs.\n"
},
"autoRenewal": {
"type": "boolean",
"description": "Whether to automatically renew auto-renew subscriptions that are up for renewal.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the user who created the bill run.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the bill run was created.\n"
},
"invoiceDate": {
"type": "string",
"format": "date",
"description": "The invoice date for this bill run, only valid for ad-hoc bill runs.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the user who last updated the bill run.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the bill run was last updated.\n"
},
"billCycleDay": {
"type": "string",
"description": "The day of the bill cycle. This field is only valid if the `batches` field is specified.\n\n**Values:** \n- `AllBillCycleDays` or one of numbers 1 - 31 for an ad-hoc bill run\n- `AllBillCycleDays`, one of numbers 1 - 31, or `AsRunDay` for a scheduled bill run\n"
},
"billRunNumber": {
"type": "string",
"description": "The number of the bill run.\n"
},
"billRunFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillRunFilterResponseType"
},
"description": "The target account or subscriptions for this bill run. \n"
},
"targetDateOffset": {
"type": "integer",
"description": "The offset compared to the bill run execution date, only valid for scheduled bill runs.\n"
},
"invoiceDateOffset": {
"type": "integer",
"description": "The offset compared to the bill run execution date, only valid for scheduled bill runs.\n"
},
"chargeTypeToExclude": {
"type": "array",
"items": {
"enum": [
"OneTime",
"Recurring",
"Usage"
],
"type": "string"
},
"description": "The types of the charges to be excluded from the generation of billing documents.\n"
},
"scheduledExecutionTime": {
"type": "string",
"format": "date-time",
"description": "The scheduled execution time for the bill run.\n"
},
"noEmailForZeroAmountInvoice": {
"type": "boolean",
"description": "Whether to suppress emails for invoices with zero total amount generated in this bill run after the bill run is complete. \n"
}
},
"description": "Container about information about the next bill run to be executed.\n"
}
],
"title": "nextRun",
"example": {
"id": "2c9890077e8a8490017e8bf3a5171a43X",
"status": "Pending",
"batches": null,
"success": true,
"autoPost": false,
"schedule": null,
"autoEmail": false,
"targetDate": "2020-02-01",
"autoRenewal": false,
"createdById": "ff808081298c6e5401298c7274a40005",
"createdDate": "2022-01-24 19:58:27",
"invoiceDate": "2020-02-01",
"updatedById": "ff808081298c6e5401298c7274a40005",
"updatedDate": "2022-01-24 19:58:27",
"billCycleDay": null,
"billRunNumber": "BR-00000016",
"billRunFilters": [
{
"accountId": "2c9081a03c63c94c013c66688a2c00bf",
"filterType": "Subscription",
"subscriptionId": "402882297e387c51017e38a245c313db"
}
],
"targetDateOffset": null,
"invoiceDateOffset": null,
"chargeTypeToExclude": [
"OneTime",
"Usage"
],
"scheduledExecutionTime": null,
"noEmailForZeroAmountInvoice": false
}
}
NotificationsDeleteNotificationHistoryForAccountResponse
{
"type": "string",
"example": "may not be null (path = PublicNotificationHistoryResource.deleteHistoryByAccountId.query param accountId, invalidValue = null)",
"description": "The error message notifying that `accountId` must not be empty."
}
NotificationsHistoryDeletionTaskResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID of the notification history deletion task."
},
"status": {
"enum": [
"RUNNING",
"FINISHED",
"FAILED"
],
"type": "string",
"description": "The status of the notification history deletion task."
},
"tenantId": {
"type": "string",
"description": "The ID of the tenant where the notification history deletion task runs."
},
"accountId": {
"type": "string",
"format": "uuid",
"description": "The ID of the account whose notification histories are deleted by the current deletion task."
},
"createdBy": {
"type": "string",
"format": "uuid",
"description": "The ID of the user who submits the notification history deletion task."
},
"createdOn": {
"type": "integer",
"description": "The timestamp when the notification history deletion task is created."
}
},
"description": "The notification history deletion task information."
}
NotificationsListEmailTemplatesResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETPublicEmailTemplateResponse"
}
},
"next": {
"type": "string",
"description": "The URI to query the next page of data, e.g. '/notification-definitions?start=1&limit=10'. The start equals request's start+limit, and the limit equals the request's limit. If the current page is the last page, this value is null."
}
}
}
NotificationsQueryNotificationDefinitionsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETPublicNotificationDefinitionResponse"
}
},
"next": {
"type": "string",
"example": "/notification-definitions?start=1&limit=10",
"description": "The URI to query the next page of data, e.g. '/notification-definitions?start=1&limit=10'. The start equals request's start+limit, and the limit equals the request's limit. If the current page is the last page, this value is null."
}
}
}
OAuthCreateTokenRequest
{
"type": "object",
"required": [
"client_id",
"client_secret",
"grant_type"
],
"properties": {
"client_id": {
"type": "string",
"maxLength": 36,
"minLength": 36,
"description": "The Client ID of the OAuth client.\n"
},
"grant_type": {
"enum": [
"client_credentials"
],
"type": "string",
"description": "The OAuth grant type that will be used to generate the token. The value of this parameter must be `client_credentials`.\n"
},
"client_secret": {
"type": "string",
"maxLength": 42,
"description": "The Client Secret that was displayed when the OAuth client was created.\n"
}
}
}
ObjectPostImportRequest
{
"type": "object",
"required": [
"ImportType",
"Name",
"File"
],
"properties": {
"File": {
"type": "string",
"format": "binary",
"description": "The data to import.\n"
},
"Name": {
"type": "string",
"description": "A descriptive name for the import.\n"
},
"ImportType": {
"enum": [
"Usage",
"Payment",
"Quote",
"TaxationDetail",
"UpdateAccountingCode",
"CreateRevenueSchedule",
"UpdateRevenueSchedule",
"DeleteRevenueSchedule",
"ImportFXRate"
],
"type": "string",
"description": "The type of data to import.\n"
}
}
}
ObjectQueriesGetCustomObjectDetailsResponse
{
"type": "object",
"example": {},
"properties": {}
}
ObjectQueriesListAccountsResponse
{
"type": "object",
"title": "QueryAccountsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedAccount"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListAmendmentsResponse
{
"type": "object",
"title": "QueryAmendmentsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedAmendment"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListBillRunsResponse
{
"type": "object",
"title": "QueryBillingRunsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedBillingRun"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListContactsResponse
{
"type": "object",
"title": "QueryContactsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedContact"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListCreditMemoApplicationsResponse
{
"type": "object",
"title": "QueryCreditMemoApplicationsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedCreditMemoApplication"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListCreditMemoItemsResponse
{
"type": "object",
"title": "QueryCreditMemoItemsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedCreditMemoItem"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListCreditMemosResponse
{
"type": "object",
"title": "QueryCreditMemosResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedCreditMemo"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListCustomObjectsResponse
{
"type": "object",
"title": "QueryCustomObjectsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"type": "object"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListDebitMemoItemsResponse
{
"type": "object",
"title": "QueryDebitMemoItemsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedDebitMemoItem"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListDebitMemosResponse
{
"type": "object",
"title": "QueryDebitMemosResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedDebitMemo"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListInvoiceItemsResponse
{
"type": "object",
"title": "QueryInvoiceItemsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedInvoiceItem"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListInvoicesResponse
{
"type": "object",
"title": "QueryInvoicesResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedInvoice"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListOrderActionsResponse
{
"type": "object",
"title": "QueryOrderActionsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedOrderAction"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListOrderLineItemsResponse
{
"type": "object",
"title": "QueryOrderLineItemsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedOrderLineItem"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListOrdersResponse
{
"type": "object",
"title": "QueryOrderssResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedOrders"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListPaymentApplicationsResponse
{
"type": "object",
"title": "QueryPaymentApplicationsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedPaymentApplication"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListPaymentMethodSnapshotsResponse
{
"type": "object",
"title": "QueryPaymentMethodSnapshotsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedPaymentMethodSnapshot"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListPaymentMethodsResponse
{
"type": "object",
"title": "QueryPaymentMethodsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedPaymentMethod"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListPaymentRunsResponse
{
"type": "object",
"title": "QueryPaymentRunsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedPaymentRun"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListPaymentScheduleItemsResponse
{
"type": "object",
"title": "QueryPaymentScheduleItemsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedPaymentScheduleItem"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListPaymentSchedulesResponse
{
"type": "object",
"title": "QueryPaymentSchedulesResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedPaymentSchedule"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListPaymentsResponse
{
"type": "object",
"title": "QueryPaymentsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedPayment"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListPrepaidBalanceFundsResponse
{
"type": "object",
"title": "QueryPrepaidBalanceFundsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedPrepaidBalanceFund"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListPrepaidBalanceTransactionsResponse
{
"type": "object",
"title": "QueryPrepaidBalanceTransactionsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedPrepaidBalanceTransaction"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListPrepaidBalancesResponse
{
"type": "object",
"title": "QueryPrepaidBalancesResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedPrepaidBalance"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListProcessedUsagesResponse
{
"type": "object",
"title": "QueryProcessedUsagesResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedProcessedUsage"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListProductRatePlanChargeTiersResponse
{
"type": "object",
"title": "QueryProductRatePlanChargeTiersResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedProductRatePlanChargeTier"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListProductRatePlanChargesResponse
{
"type": "object",
"title": "QueryProductRatePlanChargesResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedProductRatePlanCharge"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListProductRatePlansResponse
{
"type": "object",
"title": "QueryProductRatePlansResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedProductRatePlan"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListProductsResponse
{
"type": "object",
"title": "QueryProductsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedProduct"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListRatePlanChargesResponse
{
"type": "object",
"title": "QueryRatePlanChargesResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedRatePlanCharge"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListRatePlansResponse
{
"type": "object",
"title": "QueryRatePlansResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedRatePlan"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListRatingResultsResponse
{
"type": "object",
"title": "QueryRatingResultsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedRatingResult"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListRefundApplicationItemsResponse
{
"type": "object",
"title": "QueryRefundApplicationItemsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedRefundApplicationItem"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListRefundApplicationsResponse
{
"type": "object",
"title": "QueryRefundApplicationsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedRefundApplication"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListRefundsResponse
{
"type": "object",
"title": "QueryRefundsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedRefund"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListSubscriptionsResponse
{
"type": "object",
"title": "QuerySubscriptionsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedSubscription"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListTaxationItemsResponse
{
"type": "object",
"title": "QueryTaxationItemsResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedTaxationItem"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListUsagesResponse
{
"type": "object",
"title": "QueryUsagesResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedUsage"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
ObjectQueriesListValidityPeriodSummariesResponse
{
"type": "object",
"title": "QueryValidityPeriodSummarysResponse",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpandedValidityPeriodSummary"
}
},
"nextPage": {
"type": "string",
"nullable": true,
"description": "A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent.\n"
}
},
"description": ""
}
OneTimeFlatFeePricingOverride
{
"type": "object",
"title": "oneTimeFlatFee",
"required": [
"listPrice"
],
"properties": {
"listPrice": {
"type": "number",
"description": "Price of the charge.\n"
},
"originalListPrice": {
"type": "number",
"description": "The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n"
}
},
"description": "Pricing information about a one-time charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"
}
OneTimePerUnitPricingOverride
{
"type": "object",
"title": "oneTimePerUnit",
"properties": {
"uom": {
"type": "number",
"description": "Unit of measure of the standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"quantity": {
"type": "number",
"minimum": 0,
"description": "Number of units purchased.\n"
},
"listPrice": {
"type": "number",
"description": "Per-unit price of the charge.\n"
},
"originalListPrice": {
"type": "number",
"description": "The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n"
}
},
"description": "Pricing information about a one-time charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n"
}
OneTimeTieredPricingOverride
{
"type": "object",
"title": "oneTimeTiered",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeTier"
},
"description": "List of cumulative pricing tiers in the charge.\n"
},
"quantity": {
"type": "number",
"minimum": 0,
"description": "Number of units purchased.\n"
}
},
"description": "Pricing information about a one-time charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n"
}
OneTimeVolumePricingOverride
{
"type": "object",
"title": "oneTimeVolume",
"properties": {
"uom": {
"type": "number",
"description": "Unit of measure of the standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeTier"
},
"description": "List of variable pricing tiers in the charge.\n"
},
"quantity": {
"type": "number",
"minimum": 0,
"description": "Number of units purchased.\n"
}
},
"description": "Pricing information about a one-time charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n"
}
OpenPaymentMethodTypeRequestFields
{
"title": "fields",
"properties": {
"name": {
"type": "string",
"maxLength": 30,
"description": "The API name of this field. It must be uinique.\n\nAn alphanumeric string starting with a capital letter, excluding JSON preserved characters e.g. * \\ ’ ”\n\nThough this field must be defined with a string starting with a capital letter, use this string with the first letter in lowercase when you specify it in other API operations. For example, `AmazonPayToken` is the defined value for `name`. In the request of the \"Create a payment method\" API operation, use `amazonPayToken`.\n\nThis field cannot be `null` or empty or any reserved field name.\n\nThis field cannot be updated after the creation of the custom payment method type.\n"
},
"type": {
"enum": [
"string",
"date",
"datetime",
"number",
"boolean"
],
"type": "string",
"description": "The type of this field.\n\nFor the `date` type, ISO_LOCAL_DATE format is supported, such as `2011-12-03`. The timezone is not expected for the `date` type. For example, `2011-12-03+01:00` will be rejected.\n\nFor the `datetime` type, only ISO_OFFSET_DATE_TIME format is supported, such as `2011-12-03T10:15:30+01:00`. Timezone must be included. A string like `2011-12-03T10:15:30` or `2011-12-03T10:15:30+01:00[Europe/Paris]` will be rejected.\n\nIf you need to define a `date` type with timezone or a `datetime` type without timezone, use the `string` type for now.\n\nThis field cannot be `null` or empty.\n\nThis field cannot be updated after the creation of the custom payment method type.\n"
},
"index": {
"type": "integer",
"description": "The order of the field in this type, starting from 1. It must be unique.\n\nThis field cannot be `null` or empty.\n\nThis field cannot be updated after the creation of the custom payment method type.\n"
},
"label": {
"type": "string",
"maxLength": 30,
"description": "The label that is used to refer to this field in the Zuora UI.\n\nAn alphanumeric string, excluding JSON preserved characters e.g. * \\ ’ ”\n\nThis field cannot be `null` or empty or any reserved field name.\n"
},
"visible": {
"type": "boolean",
"description": "Specify `true` if this field can be retrieved through GET API or UI for displaying payment method details.\n\nThis field cannot be `null` or empty.\n\nNotes: \n - If `visible` is set to `false`, you can still specify the value of this field in the UI and POST API when creating the payment method.\n - If `visible` is set to `false` and `editable` is set to `true`, this field is not accessible through GET API or UI for displaying details, but you can still see it and edit the value in the UI and PUT API when updating this payment method.\n"
},
"checksum": {
"type": "boolean",
"description": "The checksum value of a payment method is used to identify if this payment method is the same as another one, or if this payment method is altered to another new payment method.\n\nSet this flag to `true` for the following scenarios:\n - The field should be part of checksum calculation.\n - The field is a critical differentiator for this type. \n\n \nFor example, if you select the credit card number and expiration date as the checksum fields for the CreditCard payment method type, when you modified the expiration date, Zuora considers this payment method as a different payment method compared to the original one.\n\nThis field cannot be `null` or empty.\n\nThis field cannot be updated after the creation of the custom payment method type.\n"
},
"editable": {
"type": "boolean",
"description": "Specify `true` if this field can be updated through PUT API or UI.\n\nThis field cannot be `null` or empty.\n\nNote: If `editable` is set to `false`, you can specify the value of this field in the UI and POST API when creating a payment method. However, after you created the payment method, you cannot edit this field through PUT API or UI.\n"
},
"required": {
"type": "boolean",
"description": "Specify whether this field is required.\n\nThis field cannot be `null` or empty.\n\nThis field cannot be updated after the creation of the custom payment method type.\n"
},
"maxLength": {
"type": "integer",
"description": "A maximum length limitation of the field value. The specified value must be in the range of [1,8000]. `maxLength` must be greater than or equal to `minLength`.\n\nAfter the custom payment method type is created, you can only increase the value of `maxLength`. Decreasing the value is not supported.\n"
},
"minLength": {
"type": "integer",
"description": "A minimal length limitation of the field value.\n \n0 <= `minLength` <= `maxLength`\n\nThe value of this metadata does not determine whether the field is a required field. It only defines the minimal length of the field value.\n\nAfter the custom payment method type is created, you can only decrease the value of `minLength`. Increasing the value is not supported.\n"
},
"description": {
"type": "string",
"maxLength": 70,
"description": "An explanation of this field. It can be an empty string.\n"
},
"representer": {
"type": "boolean",
"description": "This flag determines whether this field will be used for identifying this payment method in the Zuora UI. The field will be shown in the Payment Method field in the UI.\n\nThis field cannot be `null` or empty.\n\nNotes:\n - In one custom payment method type, set `representer` to `true` for at least one field .\n - In one custom payment method type, you can set `representer` to `true` for multiple fields.\n"
},
"defaultValue": {
"type": "string",
"maxLength": 255,
"description": "The default value of the field. `null` is supported.\n\nIf a required field is added after the custom payment method type is published, `defaultValue` is required.\n\nThis field cannot be updated after the creation of the custom payment method type.\n"
}
}
}
OpenPaymentMethodTypeResponseFields
{
"title": "fields",
"properties": {
"name": {
"type": "string",
"description": "The API name of this field. It must be uinique.\n"
},
"type": {
"enum": [
"string",
"date",
"datetime",
"number",
"boolean"
],
"type": "string",
"description": "The type of this field.\n"
},
"index": {
"type": "integer",
"description": "The order of the field in this type, starting from 1.\n"
},
"label": {
"type": "string",
"description": "The label that is used to refer to this field in the Zuora UI.\n"
},
"visible": {
"type": "boolean",
"description": "Specify `true` if this field can be retrieved through GET API or UI for displaying payment method details.\n\nNotes: \n - If `visible` is set to `false`, you can still specify the value of this field in the UI and POST API when creating the payment method.\n - If `visible` is set to `false` and `editable` is set to `true`, this field is not accessible through GET API or UI for displaying details, but you can still see it and edit the value in the UI and PUT API when updating this payment method.\n"
},
"checksum": {
"type": "boolean",
"description": "The checksum value of a payment method is used to identify if this payment method is the same as another one, or if this payment method is altered to another new payment method.\n\nFor example, if you select the credit card number and expiration date as the checksum fields for the CreditCard payment method type, when you modified the expiration date, Zuora considers this payment method as a different payment method compared to the original one.\n"
},
"editable": {
"type": "boolean",
"description": "Specify `true` if this field can be updated through PUT API or UI.\n\nNote: If `editable` is set to `false`, you can specify the value of this field in the UI and POST API when creating a payment method. However, after you created the payment method, you cannot edit this field through PUT API or UI.\n"
},
"required": {
"type": "boolean",
"description": "Specify whether this field is required.\n"
},
"maxLength": {
"type": "integer",
"description": "A maximum length limitation of the field value.\n"
},
"minLength": {
"type": "integer",
"description": "A minimal length limitation of the field value.\n"
},
"description": {
"type": "string",
"description": "An explanation of this field.\n"
},
"representer": {
"type": "boolean",
"description": "This flag determines whether this field will be used for identifying this payment method in the Zuora UI. The field will be shown in the Payment Method field in the UI.\n"
},
"defaultValue": {
"type": "string",
"description": "The default value of the field.\n"
}
}
}
Options
{
"type": "object",
"properties": {
"runBilling": {
"type": "boolean",
"description": "Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order."
},
"collectPayment": {
"type": "boolean",
"description": "Indicates if the current request needs to collect payments. This value can not be 'true' when 'runBilling' flag is 'false'."
},
"billingTargetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice is generated. See [What is a Target Date?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/G_Bill_Runs/Creating_Bill_Runs#What_is_a_Target_Date.3F)."
},
"maxSubscriptionsPerAccount": {
"type": "number"
}
},
"description": "Invoice or Payment."
}
Order
{
"type": "object",
"properties": {
"status": {
"enum": [
"Draft",
"Pending",
"Completed",
"Cancelled",
"Scheduled",
"Executing",
"Failed"
],
"type": "string",
"description": "The status of the order. If the order contains any `Pending Activation` or `Pending Acceptance` subscription, the order status will be `Pending`; If the order is in draft status, the order status will be `Draft`; otherwise the order status is `Completed`.\n\nThe available order statuses are as follow:\n- `Draft`: The order is in draft status.\n- `Pending`: The order is in pending status.\n- `Completed`: The order is in completed status.\n- `Cancelled`: The draft or scheduled order is cancelled.\n- `Scheduled`: The order is in scheduled status and it is only valid if the Scheduled Orders feature is enabled.\n- `Executing`: The scheduled order is executed by a scheduler and it is only valid if the Scheduled Orders feature is enabled.\n- `Failed`: The scheduled order has failed.\n"
},
"category": {
"enum": [
"NewSales",
"Return"
],
"type": "string",
"default": "NewSales",
"description": "Category of the order to indicate a product sale or return. Default value is `NewSales`.\n"
},
"currency": {
"type": "string",
"description": "Currency code."
},
"createdBy": {
"type": "string",
"description": "The ID of the user who created this order."
},
"orderDate": {
"type": "string",
"format": "date",
"description": "The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if no additinal contractEffectiveDate is provided."
},
"updatedBy": {
"type": "string",
"description": "The ID of the user who updated this order."
},
"reasonCode": {
"type": "string",
"maxLength": 255,
"description": "Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs.\n"
},
"createdDate": {
"type": "string",
"format": "datetime",
"description": "The time that the order gets created in the system, in the `YYYY-MM-DD HH:MM:SS` format."
},
"description": {
"type": "string",
"maxLength": 500,
"description": "A description of the order."
},
"orderNumber": {
"type": "string",
"description": "The order number of the order."
},
"updatedDate": {
"type": "string",
"format": "datetime",
"description": "The time that the order gets updated in the system(for example, an order description update), in the `YYYY-MM-DD HH:MM:SS` format."
},
"customFields": {
"$ref": "#/components/schemas/OrderObjectCustomFields"
},
"subscriptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ramp": {
"type": "object",
"items": {
"$ref": "#/components/schemas/RampResponse"
},
"description": "**Note**: This field 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 [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020.\n\nThe ramp definition.\n"
},
"quote": {
"$ref": "#/components/schemas/QuoteObjectFields"
},
"sequence": {
"type": "integer",
"description": "The sequence number of a certain subscription processed by the order."
},
"newVersion": {
"type": "integer",
"description": "The latest version of the subscription."
},
"baseVersion": {
"type": "integer",
"description": "The base version of the subscription."
},
"customFields": {
"$ref": "#/components/schemas/SubscriptionObjectCustomFields"
},
"orderActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderAction"
}
},
"subscriptionNumber": {
"type": "string",
"description": "The new subscription number for a new subscription created, or the existing subscription number. Unlike the order request, the subscription number here always has a value."
},
"externallyManagedBy": {
"enum": [
"Amazon",
"Apple",
"Google",
"Roku"
],
"type": "string",
"description": "An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.\n"
},
"subscriptionOwnerAccountNumber": {
"type": "string",
"description": "The number of the account that owns the subscription."
}
}
},
"description": "Represents a processed subscription, including the origin request (order actions) that create this version of subscription and the processing result (order metrics). The reference part in the request will be overridden with the info in the new subscription version."
},
"orderLineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderLineItemRetrieveOrder"
},
"description": "[Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services. \n\nWith the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models. \n\n**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 of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n"
},
"invoiceScheduleId": {
"type": "integer",
"description": "The ID of the invoice schedule associated with the order.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"schedulingOptions": {
"type": "object",
"properties": {
"scheduledDate": {
"type": "string",
"format": "date",
"description": "The date for the order scheduled.\n"
},
"scheduledDatePolicy": {
"enum": [
"SpecificDate"
],
"type": "string",
"description": "Date policy of the scheduled order."
}
},
"description": "Information of scheduled order.\n"
},
"existingAccountNumber": {
"type": "string",
"description": "The account number that this order has been created under. This is also the invoice owner of the subscriptions included in this order."
},
"scheduledOrderActivationResponse": {
"$ref": "#/components/schemas/PostOrderResponseType"
}
},
"description": "Represents the order information that will be returned in the GET call."
}
OrderAction
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Id of the order action processed in the order."
},
"type": {
"enum": [
"CreateSubscription",
"TermsAndConditions",
"AddProduct",
"UpdateProduct",
"RemoveProduct",
"RenewSubscription",
"CancelSubscription",
"OwnerTransfer",
"Suspend",
"Resume",
"ChangePlan"
],
"type": "string",
"description": "Type of the order action.\n\n**Note**: The change plan type of order action is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.\n"
},
"resume": {
"$ref": "#/components/schemas/GetOrderResume"
},
"suspend": {
"$ref": "#/components/schemas/GetOrderSuspend"
},
"sequence": {
"type": "integer",
"description": "The sequence of the order actions processed in the order."
},
"addProduct": {
"$ref": "#/components/schemas/RatePlanOverride"
},
"changePlan": {
"$ref": "#/components/schemas/ChangePlan"
},
"orderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItem"
},
"description": "The `orderItems` nested field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
},
"changeReason": {
"type": "string",
"description": "The change reason set for an order action when an order is created.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderActionObjectCustomFields"
},
"orderMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/orderMetric"
},
"description": "The container for order metrics.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n\n**Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects. \n* [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr)\n* [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv)\n* [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb)\n\nIt is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/).\n\nWhereas new customers, and existing customers not currently on [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders), will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported.\n"
},
"triggerDates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerDate"
},
"description": "Container for the contract effective, service activation, and customer acceptance dates of the order action. \n\nIf [Zuora is configured to require service activation](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F) and the `ServiceActivation` field is not set for a `CreateSubscription` order action, a `Pending` order and a `Pending Activation` subscription are created.\n\nIf [Zuora is configured to require customer acceptance](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F) and the `CustomerAcceptance` field is not set for a `CreateSubscription` order action, a `Pending` order and a `Pending Acceptance` subscription are created. At the same time, if the service activation date field is also required and not set, a `Pending` order and a `Pending Activation` subscription are created instead.\n\nIf [Zuora is configured to require service activation](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F) and the `ServiceActivation` field is not set for either of the following order actions, a `Pending` order is created. The subscription status is not impacted. **Note:** This feature is in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n\nIf [Zuora is configured to require customer acceptance](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F) and the `CustomerAcceptance` field is not set for either of the following order actions, a `Pending` order is created. The subscription status is not impacted. **Note:** This feature is in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n"
},
"ownerTransfer": {
"$ref": "#/components/schemas/OwnerTransfer"
},
"removeProduct": {
"$ref": "#/components/schemas/RemoveProduct"
},
"updateProduct": {
"$ref": "#/components/schemas/RatePlanUpdate",
"description": ""
},
"renewSubscription": {
"$ref": "#/components/schemas/RenewSubscription"
},
"cancelSubscription": {
"$ref": "#/components/schemas/CancelSubscription"
},
"createSubscription": {
"$ref": "#/components/schemas/CreateSubscription"
},
"termsAndConditions": {
"$ref": "#/components/schemas/TermsAndConditions"
}
},
"description": "Represents the processed order action."
}
OrderActionCommon
{
"type": "object",
"title": "OrderAction",
"properties": {
"changeReason": {
"type": "string",
"description": "The change reason set for an order action when the order action is updated.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderActionCustomFields"
}
}
}
OrderActionCustomFields
{
"type": "object",
"title": "OrderActionCustomFields",
"description": "Container for custom fields of an Order Action object.\n",
"additionalProperties": {
"description": "Custom fields of the Order Action object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See <a href=\"https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields\" target=\"_blank\">Manage Custom Fields</a> for more information.\n"
}
}
OrderActionObjectCustomFields
{
"type": "object",
"title": "orderActionFieldsCustom",
"description": "Container for custom fields of an Order Action object.\n",
"additionalProperties": {
"description": "Custom fields of the Order Action object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
OrderActionRatePlanAmendment
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The amendment ID.\n"
},
"code": {
"type": "string",
"description": "The amendment code.\n"
},
"name": {
"type": "string",
"description": "The name of the amendment.\n"
},
"type": {
"type": "string",
"description": "Type of the amendment.\nPossible values are:\n\n\n- NewProduct\n- RemoveProduct\n- UpdateProduct\n"
},
"createdBy": {
"type": "string",
"description": "The ID of the user who created this amendment.\n"
},
"updatedBy": {
"type": "string",
"description": "The ID of the user who updated this amendment."
},
"createdDate": {
"type": "string",
"format": "datetime",
"description": "The time that the amendment gets created in the system, in the `YYYY-MM-DD HH:MM:SS` format."
},
"description": {
"type": "string",
"description": "Description of the amendment.\n"
},
"updatedDate": {
"type": "string",
"format": "datetime",
"description": "The time that the amendment gets updated in the system, in the `YYYY-MM-DD HH:MM:SS` format."
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the amendment changes take effective. \n"
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the amendment becomes effective for billing purposes, as `yyyy-mm-dd`.\n"
},
"serviceActivationDate": {
"type": "string",
"format": "date",
"description": "The date when service is activated, as `yyyy-mm-dd`.\n"
},
"customerAcceptanceDate": {
"type": "string",
"format": "date",
"description": "The date when the customer accepts the amendment changes to the subscription, as `yyyy-mm-dd`.\n"
}
},
"description": "The amendment that is related to the subscription rate plan.\n"
}
OrderActionRatePlanBillingUpdate
{
"type": "object",
"properties": {
"billingPeriodAlignment": {
"enum": [
"AlignToCharge",
"AlignToSubscriptionStart",
"AlignToTermStart"
],
"type": "string"
}
}
}
OrderActionRatePlanChargeModelDataOverride
{
"type": "object",
"title": "chargeModelData",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeTier"
},
"description": "List of cumulative pricing tiers in the charge.\n\n**Note**: When you override tiers of the charge with a High Water Mark Pricing charge model, you have to provide all of the tiers, including the ones you do not want to change. The new tiers will completely override the previous ones. The High Water Mark Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
},
"chargeModelConfiguration": {
"type": "object",
"properties": {
"formula": {
"type": "string",
"description": "The pricing formula to calculate actual rating amount for each usage record.\n\nThis field is only available for the usage-based charges that use the Multi-Attribute Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
},
"customFieldPerUnitRate": {
"type": "string",
"description": "The custom field that carries the per-unit rate for each usage record. For example, `perUnitAmount__c`.\n\nThis field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
},
"customFieldTotalAmount": {
"type": "string",
"description": "The custom field that carries the total amount to charge for a usage record. For example, `totalAmount__c`.\n\nThis field is only available for the usage-based charges that use the Pre-Rated Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
}
}
}
},
"description": "Container for charge model configuration data.\n\n**Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
}
OrderActionRatePlanChargeOverride
{
"type": "object",
"title": "charge",
"required": [
"productRatePlanChargeId"
],
"properties": {
"billing": {
"type": "object",
"properties": {
"billCycleDay": {
"type": "integer",
"maximum": 31,
"minimum": 0,
"description": "Day of the month that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofMonth`.\n"
},
"billCycleType": {
"enum": [
"DefaultFromCustomer",
"SpecificDayofMonth",
"SubscriptionStartDay",
"ChargeTriggerDay",
"SpecificDayofWeek"
],
"type": "string",
"description": "Specifies how Zuora determines the day that each billing period begins on.\n\n * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.\n * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.\n * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.\n * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.\n * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.\n"
},
"billingPeriod": {
"enum": [
"Month",
"Quarter",
"Semi_Annual",
"Annual",
"Eighteen_Months",
"Two_Years",
"Three_Years",
"Five_Years",
"Specific_Months",
"Subscription_Term",
"Week",
"Specific_Weeks"
],
"type": "string",
"description": "Billing frequency of the charge. The value of this field controls the duration of each billing period.\n\nIf the value of this field is `Specific_Months` or `Specific_Weeks`, use the `specificBillingPeriod` field to specify the duration of each billing period.\n"
},
"billingTiming": {
"enum": [
"IN_ADVANCE",
"IN_ARREARS"
],
"type": "string",
"description": "Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).\n"
},
"weeklyBillCycleDay": {
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string",
"description": "Day of the week that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofWeek`.\n"
},
"specificBillingPeriod": {
"type": "integer",
"description": "Duration of each billing period in months or weeks, depending on the value of the `billingPeriod` field. Only applicable if the value of the `billingPeriod` field is `Specific_Months` or `Specific_Weeks`.\n"
},
"billingPeriodAlignment": {
"enum": [
"AlignToCharge",
"AlignToSubscriptionStart",
"AlignToTermStart"
],
"type": "string",
"description": "Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges.\n\n* `AlignToCharge` - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active.\n* `AlignToSubscriptionStart` - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription.\n* `AlignToTermStart` - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term.\n\nSee the `billCycleType` field for information about how Zuora determines the billing day.\n"
}
},
"description": "Billing information about the charge.\n"
},
"endDate": {
"$ref": "#/components/schemas/OrderActionRatePlanEndConditions"
},
"pricing": {
"type": "object",
"properties": {
"discount": {
"$ref": "#/components/schemas/OrderActionRatePlanDiscountPricingOverride"
},
"usageTiered": {
"$ref": "#/components/schemas/OrderActionRatePlanUsageTieredPricingOverride"
},
"usageVolume": {
"$ref": "#/components/schemas/OrderActionRatePlanUsageVolumePricingOverride"
},
"usageFlatFee": {
"$ref": "#/components/schemas/OrderActionRatePlanUsageFlatFeePricingOverride"
},
"usageOverage": {
"$ref": "#/components/schemas/OrderActionRatePlanUsageOveragePricingOverride"
},
"usagePerUnit": {
"$ref": "#/components/schemas/OrderActionRatePlanUsagePerUnitPricingOverride"
},
"oneTimeTiered": {
"$ref": "#/components/schemas/OrderActionRatePlanOneTimeTieredPricingOverride"
},
"oneTimeVolume": {
"$ref": "#/components/schemas/OrderActionRatePlanOneTimeVolumePricingOverride"
},
"oneTimeFlatFee": {
"$ref": "#/components/schemas/OrderActionRatePlanOneTimeFlatFeePricingOverride"
},
"oneTimePerUnit": {
"$ref": "#/components/schemas/OrderActionRatePlanOneTimePerUnitPricingOverride"
},
"chargeModelData": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeModelDataOverride"
},
"recurringTiered": {
"$ref": "#/components/schemas/OrderActionRatePlanRecurringTieredPricingOverride"
},
"recurringVolume": {
"$ref": "#/components/schemas/OrderActionRatePlanRecurringVolumePricingOverride"
},
"recurringFlatFee": {
"$ref": "#/components/schemas/OrderActionRatePlanRecurringFlatFeePricingOverride"
},
"recurringPerUnit": {
"$ref": "#/components/schemas/OrderActionRatePlanRecurringPerUnitPricingOverride"
},
"recurringDelivery": {
"$ref": "#/components/schemas/OrderActionRatePlanRecurringDeliveryPricingOverride"
},
"usageTieredWithOverage": {
"$ref": "#/components/schemas/OrderActionRatePlanUsageTieredWithOveragePricingOverride"
}
},
"description": "Pricing information about the charge.\n"
},
"startDate": {
"$ref": "#/components/schemas/OrderActionRatePlanTriggerParams"
},
"revRecCode": {
"type": "string",
"maxLength": 70,
"description": "Revenue Recognition Code\n"
},
"description": {
"type": "string",
"maxLength": 500,
"description": "Description of the charge.\n"
},
"uniqueToken": {
"type": "string",
"maxLength": 50,
"description": "Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.\n"
},
"chargeNumber": {
"type": "string",
"maxLength": 50,
"description": "Charge number of the charge. For example, C-00000307.\n\nIf you do not set this field, Zuora will generate the charge number.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderActionRatePlanRatePlanChargeObjectCustomFields"
},
"revRecTriggerCondition": {
"enum": [
"Contract Effective Date",
"Service Activation Date",
"Customer Acceptance Date"
],
"type": "string",
"description": "Specifies the revenue recognition trigger condition.\n\n * `Contract Effective Date`\n * `Service Activation Date`\n * `Customer Acceptance Date`\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "Internal identifier of the product rate plan charge that the charge is based on.\n"
},
"revenueRecognitionRuleName": {
"enum": [
"Recognize upon invoicing",
"Recognize daily over time"
],
"type": "string",
"description": "Specifies the revenue recognition rule.\n\n * `Recognize upon invoicing`\n * `Recognize daily over time`\n"
}
},
"description": "Charge associated with a rate plan.\n"
}
OrderActionRatePlanChargeRemove
{
"type": "object",
"example": {
"uniqueToken": "uniqueToken",
"chargeNumber": "chargeNumber",
"customFields": {
"key": "{}"
},
"productRatePlanNumber": "productRatePlanNumber",
"productRatePlanChargeId": "productRatePlanChargeId"
},
"properties": {
"uniqueToken": {
"type": "string",
"description": "A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions.\n"
},
"chargeNumber": {
"type": "string",
"description": "Read only. Identifies the charge to be updated.\n"
},
"customFields": {
"type": "object",
"title": "ratePlanChargeFieldsCustom",
"description": "Container for custom fields of a Rate Plan Charge object.\n",
"additionalProperties": {
"type": "object",
"description": "Custom fields of the Rate Plan Charge object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "Identifier of the rate plan that was updated.\n"
}
},
"description": "The JSON object containing the information for a charge update(custom fields only) in the\n'RemoveProduct' type order action.\nA custom field of rate plan charge can be updated from a subscription through one\norder action.\n- If you update customFields of a charge while removing a rate plan, specify the following fields:\n - `chargeNumber`\n - `productRatePlanChargeId`\n - `productRatePlanNumber`\n - `uniqueToken`\n - `customFields`\n"
}
OrderActionRatePlanChargeTier
{
"type": "object",
"title": "chargeTier",
"required": [
"tier",
"startingUnit",
"price",
"priceFormat"
],
"properties": {
"tier": {
"type": "integer",
"minimum": 1,
"description": "Index of the tier in the charge.\n"
},
"price": {
"type": "number",
"description": "Price or per-unit price of the tier, depending on the value of the `priceFormat` field.\n"
},
"endingUnit": {
"type": "number",
"description": "Limit on the number of units for which the tier is effective.\n"
},
"priceFormat": {
"enum": [
"FlatFee",
"PerUnit"
],
"type": "string",
"description": "Specifies whether the tier has a fixed price or a per-unit price.\n"
},
"startingUnit": {
"type": "number",
"description": "Number of units at which the tier becomes effective.\n"
}
}
}
OrderActionRatePlanChargeUpdate
{
"type": "object",
"properties": {
"billing": {
"$ref": "#/components/schemas/OrderActionRatePlanBillingUpdate"
},
"pricing": {
"$ref": "#/components/schemas/OrderActionRatePlanPricingUpdate"
},
"description": {
"type": "string",
"description": "Description of the charge.\n"
},
"uniqueToken": {
"type": "string",
"description": "A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions.\n"
},
"chargeNumber": {
"type": "string",
"description": "Read only. Identifies the charge to be updated.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderActionRatePlanRatePlanChargeObjectCustomFields"
},
"effectiveDate": {
"$ref": "#/components/schemas/OrderActionRatePlanTriggerParams"
}
},
"description": "The JSON object containing the information for a charge update in the 'UpdateProduct' type order action.",
"x-konfig-properties": {
"billing": {
"description": "Billing information about the charge.\n"
},
"pricing": {
"description": "Pricing information about the charge.\n"
}
}
}
OrderActionRatePlanDiscountPricingOverride
{
"type": "object",
"title": "discount",
"properties": {
"discountLevel": {
"enum": [
"rateplan",
"subscription",
"account"
],
"type": "string",
"description": "Application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge.\n"
},
"discountAmount": {
"type": "number",
"description": "Only applicable if the discount charge is a fixed-amount discount.\n"
},
"applyDiscountTo": {
"enum": [
"ONETIME",
"RECURRING",
"USAGE",
"ONETIMERECURRING",
"ONETIMEUSAGE",
"RECURRINGUSAGE",
"ONETIMERECURRINGUSAGE"
],
"type": "string",
"description": "Specifies which type of charge the discount charge applies to.\n"
},
"priceChangeOption": {
"enum": [
"NoChange",
"UseLatestProductCatalogPricing"
],
"type": "string",
"description": "Specifies how Zuora changes the price of the charge each time the subscription renews.\n"
},
"discountPercentage": {
"type": "number",
"description": "Only applicable if the discount charge is a percentage discount.\n"
}
},
"description": "Pricing information about a discount charge.\n"
}
OrderActionRatePlanDiscountPricingUpdate
{
"type": "object",
"properties": {
"discountLevel": {
"enum": [
"rateplan",
"subscription",
"account"
],
"type": "string",
"description": "Application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge.\n"
},
"applyDiscountTo": {
"enum": [
"ONETIME",
"RECURRING",
"USAGE",
"ONETIMERECURRING",
"ONETIMEUSAGE",
"RECURRINGUSAGE",
"ONETIMERECURRINGUSAGE"
],
"type": "string",
"description": "Specifies which type of charge the discount charge applies to.\n"
},
"priceChangeOption": {
"enum": [
"NoChange",
"UseLatestProductCatalogPricing"
],
"type": "string",
"description": "Specifies how Zuora changes the price of the charge each time the subscription renews.\n"
},
"discountPercentage": {
"type": "number",
"description": "The amount of the discount as a percentage. This field is only used for percentage discounts.\n"
}
}
}
OrderActionRatePlanEndConditions
{
"type": "object",
"title": "endDate",
"properties": {
"upToPeriods": {
"type": "integer",
"description": "Duration of the charge in billing periods, days, weeks, months, or years, depending on the value of the `upToPeriodsType` field. Only applicable if the value of the `endDateCondition` field is `Fixed_Period`.\n"
},
"specificEndDate": {
"type": "string",
"format": "date",
"description": "Date in YYYY-MM-DD format. Only applicable if the value of the `endDateCondition` field is `Specific_End_Date`.\n"
},
"upToPeriodsType": {
"enum": [
"Billing_Periods",
"Days",
"Weeks",
"Months",
"Years"
],
"type": "string",
"description": "Unit of time that the charge duration is measured in. Only applicable if the value of the `endDateCondition` field is `Fixed_Period`.\n"
},
"endDateCondition": {
"enum": [
"Subscription_End",
"Fixed_Period",
"Specific_End_Date"
],
"type": "string",
"description": "Condition for the charge to become inactive.\n\nIf the value of this field is `Fixed_Period`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields.\n\nIf the value of this field is `Specific_End_Date`, use the `specificEndDate` field to specify the date when then charge becomes inactive.\n"
}
},
"description": "Specifies when a charge becomes inactive.\n"
}
OrderActionRatePlanOneTimeFlatFeePricingOverride
{
"type": "object",
"title": "oneTimeFlatFee",
"required": [
"listPrice"
],
"properties": {
"listPrice": {
"type": "number",
"description": "Price of the charge.\n"
}
},
"description": "Pricing information about a one-time charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"
}
OrderActionRatePlanOneTimePerUnitPricingOverride
{
"type": "object",
"title": "oneTimePerUnit",
"properties": {
"quantity": {
"type": "number",
"minimum": 0,
"description": "Number of units purchased.\n"
},
"listPrice": {
"type": "number",
"description": "Per-unit price of the charge.\n"
}
},
"description": "Pricing information about a one-time charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n"
}
OrderActionRatePlanOneTimeTieredPricingOverride
{
"type": "object",
"title": "oneTimeTiered",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeTier"
},
"description": "List of cumulative pricing tiers in the charge.\n"
},
"quantity": {
"type": "number",
"minimum": 0,
"description": "Number of units purchased.\n"
}
},
"description": "Pricing information about a one-time charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n"
}
OrderActionRatePlanOneTimeVolumePricingOverride
{
"type": "object",
"title": "oneTimeVolume",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeTier"
},
"description": "List of variable pricing tiers in the charge.\n"
},
"quantity": {
"type": "number",
"minimum": 0,
"description": "Number of units purchased.\n"
}
},
"description": "Pricing information about a one-time charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n"
}
OrderActionRatePlanOrder
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The order ID."
},
"orderNumber": {
"type": "string",
"description": "The order number of the order."
},
"orderActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanOrderAction"
}
}
},
"description": "The order that is related to the subscription rate plan.\n"
}
OrderActionRatePlanOrderAction
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Id of the order action processed in the order."
},
"type": {
"enum": [
"AddProduct",
"UpdateProduct",
"RemoveProduct"
],
"type": "string",
"description": "Type of the order action."
},
"addProduct": {
"$ref": "#/components/schemas/OrderActionRatePlanRatePlanOverride"
},
"customFields": {
"$ref": "#/components/schemas/OrderActionRatePlanOrderActionObjectCustomFields"
},
"removeProduct": {
"$ref": "#/components/schemas/OrderActionRatePlanRemoveProduct"
},
"updateProduct": {
"$ref": "#/components/schemas/OrderActionRatePlanRatePlanUpdate"
}
},
"description": "Represents the processed order action."
}
OrderActionRatePlanOrderActionObjectCustomFields
{
"type": "object",
"title": "orderActionFieldsCustom",
"description": "Container for custom fields of an Order Action object.\n",
"additionalProperties": {
"description": "Custom fields of the Order Action object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
OrderActionRatePlanPriceChangeParams
{
"type": "object",
"properties": {
"priceChangeOption": {
"enum": [
"NoChange",
"SpecificPercentageValue",
"UseLatestProductCatalogPricing"
],
"type": "string",
"description": "Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n"
},
"priceIncreasePercentage": {
"type": "number",
"minimum": -100,
"description": "Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.\n"
}
}
}
OrderActionRatePlanPricingUpdate
{
"type": "object",
"properties": {
"discount": {
"$ref": "#/components/schemas/OrderActionRatePlanDiscountPricingUpdate"
},
"usageTiered": {
"$ref": "#/components/schemas/OrderActionRatePlanUsageTieredPricingUpdate"
},
"usageVolume": {
"$ref": "#/components/schemas/OrderActionRatePlanUsageVolumePricingUpdate"
},
"usageFlatFee": {
"$ref": "#/components/schemas/OrderActionRatePlanUsageFlatFeePricingUpdate"
},
"usageOverage": {
"$ref": "#/components/schemas/OrderActionRatePlanUsageOveragePricingUpdate"
},
"usagePerUnit": {
"$ref": "#/components/schemas/OrderActionRatePlanUsagePerUnitPricingUpdate"
},
"chargeModelData": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeModelDataOverride"
},
"recurringTiered": {
"$ref": "#/components/schemas/OrderActionRatePlanRecurringTieredPricingUpdate"
},
"recurringVolume": {
"$ref": "#/components/schemas/OrderActionRatePlanRecurringVolumePricingUpdate"
},
"recurringFlatFee": {
"$ref": "#/components/schemas/OrderActionRatePlanRecurringFlatFeePricingUpdate"
},
"recurringPerUnit": {
"$ref": "#/components/schemas/OrderActionRatePlanRecurringPerUnitPricingUpdate"
},
"recurringDelivery": {
"$ref": "#/components/schemas/OrderActionRatePlanRecurringDeliveryPricingUpdate"
},
"usageTieredWithOverage": {
"$ref": "#/components/schemas/OrderActionRatePlanUsageTieredWithOveragePricingUpdate"
}
},
"x-konfig-properties": {
"discount": {
"description": "Pricing information about a discount charge.\n"
},
"usageTiered": {
"description": "Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.\n"
},
"usageVolume": {
"description": "Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.\n"
},
"usageFlatFee": {
"description": "Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"
},
"usageOverage": {
"description": "Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.\n"
},
"usagePerUnit": {
"description": "Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.\n"
},
"chargeModelData": {
"description": "Container for charge model configuration data.\n"
},
"recurringTiered": {
"description": "Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n"
},
"recurringVolume": {
"description": "Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n"
},
"recurringFlatFee": {
"description": "Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"
},
"recurringPerUnit": {
"description": "Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n"
},
"recurringDelivery": {
"description": "Pricing information about a recurring charge that uses the Delivery Pricing charge model. In this charge model, the charge has a fixed price. This field is only available if you have the Delivery Pricing charge model enabled.\n"
},
"usageTieredWithOverage": {
"description": "Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.\n"
}
}
}
OrderActionRatePlanRatePlanChargeObjectCustomFields
{
"type": "object",
"title": "ratePlanChargeFieldsCustom",
"description": "Container for custom fields of a Rate Plan Charge object.\n",
"additionalProperties": {
"description": "Custom fields of the Rate Plan Charge object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
OrderActionRatePlanRatePlanObjectCustomFields
{
"type": "object",
"title": "ratePlanFieldsCustom",
"description": "Container for custom fields of a Rate Plan object.\n",
"additionalProperties": {
"description": "Custom fields of the Rate Plan object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
OrderActionRatePlanRatePlanOverride
{
"type": "object",
"title": "ratePlan",
"required": [
"productRatePlanId"
],
"properties": {
"uniqueToken": {
"type": "string",
"maxLength": 50,
"description": "Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderActionRatePlanRatePlanObjectCustomFields"
},
"newRatePlanId": {
"type": "string",
"description": "Internal identifier of the rate plan.\n"
},
"chargeOverrides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeOverride"
},
"description": "List of charges associated with the rate plan.\n"
},
"productRatePlanId": {
"type": "string",
"description": "Internal identifier of the product rate plan that the rate plan is based on.\n"
}
},
"description": "Rate plan associated with a subscription.\n"
}
OrderActionRatePlanRatePlanUpdate
{
"type": "object",
"title": "updateProduct",
"properties": {
"ratePlanId": {
"type": "string",
"description": "Internal identifier of the rate plan that was updated.\n"
},
"uniqueToken": {
"type": "string",
"description": "A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderActionRatePlanRatePlanObjectCustomFields"
},
"chargeUpdates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeUpdate"
}
},
"newRatePlanId": {
"type": "string",
"description": "Internal identifier of the updated rate plan in the new subscription version.\n"
},
"specificUpdateDate": {
"type": "string",
"format": "date",
"description": "\nThe date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.\n\nSee [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.\n"
}
},
"description": "Information about an order action of type `UpdateProduct`.\n"
}
OrderActionRatePlanRecurringDeliveryPricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"listPrice": {
"type": "number",
"description": "Price of the charge in each recurring period.\n"
},
"deliverySchedule": {
"$ref": "#/components/schemas/DeliveryScheduleParams"
}
}
}
],
"title": "recurringDelivery",
"description": "Pricing information about a recurring charge that uses the Delivery Pricing charge model. In this charge model, the charge has a fixed price. This field is only available if you have the Delivery Pricing charge model enabled.\n"
}
OrderActionRatePlanRecurringDeliveryPricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"listPrice": {
"type": "number"
},
"deliverySchedule": {
"$ref": "#/components/schemas/DeliveryScheduleParams"
}
}
}
]
}
OrderActionRatePlanRecurringFlatFeePricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"listPrice": {
"type": "number",
"description": "Price of the charge in each recurring period.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year",
"Per_Specific_Months"
],
"type": "string",
"description": "Specifies the duration of each recurring period.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"description": "The number of months for the list price base of the charge. The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.\n"
}
}
}
],
"title": "recurringFlatFee",
"description": "Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"
}
OrderActionRatePlanRecurringFlatFeePricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"listPrice": {
"type": "number"
}
}
}
]
}
OrderActionRatePlanRecurringPerUnitPricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"quantity": {
"type": "number",
"minimum": 0,
"description": "Number of units purchased.\n"
},
"listPrice": {
"type": "number",
"description": "Per-unit price of the charge in each recurring period.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year",
"Per_Specific_Months"
],
"type": "string",
"description": "Specifies the duration of each recurring period.\n\n**Note**: The `Per_Year` and `Per_Specific_Months` enum values are available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled. \n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"description": "The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.\n"
}
}
}
],
"title": "recurringPerUnit",
"description": "Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n"
}
OrderActionRatePlanRecurringPerUnitPricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"quantity": {
"type": "number",
"minimum": 0
},
"listPrice": {
"type": "number"
}
}
}
]
}
OrderActionRatePlanRecurringTieredPricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeTier"
},
"description": "List of cumulative pricing tiers in the charge.\n"
},
"quantity": {
"type": "number",
"minimum": 0,
"description": "Number of units purchased.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year",
"Per_Specific_Months"
],
"type": "string",
"description": "Specifies the duration of each recurring period.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"description": "The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.\n"
}
}
}
],
"title": "recurringTiered",
"description": "Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n"
}
OrderActionRatePlanRecurringTieredPricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeTier"
}
},
"quantity": {
"type": "number",
"minimum": 0
}
}
}
]
}
OrderActionRatePlanRecurringVolumePricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeTier"
},
"description": "List of variable pricing tiers in the charge.\n"
},
"quantity": {
"type": "number",
"minimum": 0,
"description": "Number of units purchased.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year",
"Per_Specific_Months"
],
"type": "string",
"description": "Specifies the duration of each recurring period.\n\n**Note**: The `Per_Year` and `Per_Specific_Months` enum values are available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"description": "The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.\n"
}
}
}
],
"title": "recurringVolume",
"description": "Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n"
}
OrderActionRatePlanRecurringVolumePricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeTier"
}
},
"quantity": {
"type": "number",
"minimum": 0
}
}
}
]
}
OrderActionRatePlanRemoveProduct
{
"type": "object",
"title": "removeProduct",
"properties": {
"ratePlanId": {
"type": "string",
"description": "Internal identifier of the rate plan to remove.\n"
},
"uniqueToken": {
"type": "string",
"description": "A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions.A unique string in the order to represent the rate plan."
}
},
"description": "Information about an order action of type `RemoveProduct`.\n"
}
OrderActionRatePlanTriggerParams
{
"type": "object",
"title": "startDate",
"properties": {
"triggerEvent": {
"enum": [
"ContractEffective",
"ServiceActivation",
"CustomerAcceptance"
],
"type": "string",
"description": "Condition for the charge to become active.\n\nIf the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.\n"
},
"specificTriggerDate": {
"type": "string",
"format": "date",
"description": "Date in YYYY-MM-DD format. Only applicable if the value of the `triggerEvent` field is `SpecificDate`.\n\nWhile this field is applicable, if this field is not set, your `CreateSubscription` order action creates a `Pending` order and a `Pending Acceptance` subscription. If at the same time the service activation date is required and not set, a `Pending Activation` subscription is created.\n\nWhile this field is applicable, if this field is not set, the following order actions create a `Pending` order but do not impact the subscription status. **Note**: This feature is in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n"
}
},
"description": "Specifies when a charge becomes active.\n"
}
OrderActionRatePlanUsageFlatFeePricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"listPrice": {
"type": "number",
"description": "Price of the charge.\n"
}
}
}
],
"title": "usageFlatFee",
"description": "Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"
}
OrderActionRatePlanUsageFlatFeePricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"listPrice": {
"type": "number"
}
}
}
]
}
OrderActionRatePlanUsageOveragePricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"overagePrice": {
"type": "number",
"description": "Price per overage unit consumed.\n"
},
"includedUnits": {
"type": "number",
"minimum": 0,
"description": "Number of free units that may be consumed.\n"
},
"numberOfPeriods": {
"type": "integer",
"minimum": 1,
"description": "Number of periods that Zuora considers when calculating overage charges with overage smoothing.\n"
},
"unusedUnitsCreditRates": {
"type": "number",
"description": "Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the `overageUnusedUnitsCreditOption` field is `CreditBySpecificRate`.\n"
},
"overageUnusedUnitsCreditOption": {
"enum": [
"NoCredit",
"CreditBySpecificRate"
],
"type": "string",
"description": "Specifies whether to credit the customer for unused units.\n\nIf the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units.\n"
}
}
}
],
"title": "usageOverage",
"description": "Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.\n"
}
OrderActionRatePlanUsageOveragePricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"overagePrice": {
"type": "number"
},
"includedUnits": {
"type": "number",
"description": "A certain quantity of units for free in the overage charge model. It cannot be negative. It must be 0 and above. Decimals are allowed.\n"
}
}
}
]
}
OrderActionRatePlanUsagePerUnitPricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"listPrice": {
"type": "number",
"description": "Per-unit price of the charge.\n"
},
"ratingGroup": {
"enum": [
"ByBillingPeriod",
"ByUsageStartDate",
"ByUsageRecord",
"ByUsageUpload"
],
"type": "string",
"description": "Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.\n * ByBillingPeriod (default): The rating is based on all the usages in a billing period.\n * ByUsageStartDate: The rating is based on all the usages on the same usage start date.\n * ByUsageRecord: The rating is based on each usage record.\n * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.\n"
}
}
}
],
"title": "usagePerUnit",
"description": "Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.\n"
}
OrderActionRatePlanUsagePerUnitPricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"listPrice": {
"type": "number"
}
}
}
]
}
OrderActionRatePlanUsageTieredPricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeTier"
},
"description": "List of cumulative pricing tiers in the charge.\n"
},
"ratingGroup": {
"enum": [
"ByBillingPeriod",
"ByUsageStartDate",
"ByUsageRecord",
"ByUsageUpload"
],
"type": "string",
"description": "Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.\n * ByBillingPeriod (default): The rating is based on all the usages in a billing period.\n * ByUsageStartDate: The rating is based on all the usages on the same usage start date.\n * ByUsageRecord: The rating is based on each usage record.\n * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.\n"
}
}
}
],
"title": "usageTiered",
"description": "Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.\n"
}
OrderActionRatePlanUsageTieredPricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeTier"
}
}
}
}
]
}
OrderActionRatePlanUsageTieredWithOveragePricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeTier"
},
"description": "List of cumulative pricing tiers in the charge.\n"
},
"overagePrice": {
"type": "number",
"description": "Price per overage unit consumed.\n"
},
"numberOfPeriods": {
"type": "integer",
"minimum": 1,
"description": "Number of periods that Zuora considers when calculating overage charges with overage smoothing.\n"
},
"unusedUnitsCreditRates": {
"type": "number",
"description": "Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the `overageUnusedUnitsCreditOption` field is `CreditBySpecificRate`.\n"
},
"overageUnusedUnitsCreditOption": {
"enum": [
"NoCredit",
"CreditBySpecificRate"
],
"type": "string",
"description": "Specifies whether to credit the customer for unused units.\n\nIf the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units.\n"
}
}
}
],
"title": "usageTieredWithOverage",
"description": "Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.\n"
}
OrderActionRatePlanUsageTieredWithOveragePricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeTier"
}
},
"overagePrice": {
"type": "number"
}
}
}
]
}
OrderActionRatePlanUsageVolumePricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeTier"
},
"description": "List of variable pricing tiers in the charge.\n"
},
"ratingGroup": {
"enum": [
"ByBillingPeriod",
"ByUsageStartDate",
"ByUsageRecord",
"ByUsageUpload"
],
"type": "string",
"description": "Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.\n * ByBillingPeriod (default): The rating is based on all the usages in a billing period.\n * ByUsageStartDate: The rating is based on all the usages on the same usage start date.\n * ByUsageRecord: The rating is based on each usage record.\n * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.\n"
}
}
}
],
"title": "usageVolume",
"description": "Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.\n"
}
OrderActionRatePlanUsageVolumePricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/OrderActionRatePlanPriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeTier"
}
}
}
}
]
}
OrderDeltaMetric
{
"type": "object",
"properties": {
"endDate": {
"type": "string",
"format": "date",
"description": "The end date for the order delta metric.\n"
},
"currency": {
"type": "string",
"description": "ISO 3-letter currency code (uppercase). For example, USD.\n"
},
"netAmount": {
"type": "number",
"description": "The net amount for the metric. The is the amount with discounts applied\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date for the order delta metric.\n"
},
"grossAmount": {
"type": "number",
"description": "The gross amount for the metric. The is the amount excluding applied discount.\n"
},
"chargeNumber": {
"type": "string",
"description": "The charge number for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.\n"
},
"orderActionId": {
"type": "string",
"description": "The Id for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n"
},
"orderActionType": {
"type": "string",
"description": "The type for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n"
},
"ratePlanChargeId": {
"type": "string",
"description": "The id for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "The number of the subscription. This field can be null if the metric is generated for an Order Line Item.\n"
},
"orderActionSequence": {
"type": "string",
"description": "The sequence for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n"
},
"orderLineItemNumber": {
"type": "string",
"description": "A sequential number auto-assigned for each of order line items in a order, used as an index, for example, \"1\".\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The Id for the associated Product Rate Plan Charge. This field can be null if the Order Line Item is not associated with a Product Rate Plan Charge.\n"
}
}
}
OrderDeltaTcb
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/OrderDeltaMetric"
},
{
"type": "object",
"properties": {
"orderLineItemId": {
"type": "string",
"format": "UUID",
"description": "The sytem generated Id for the Order Line Item. This field can be null if the metric is generated for a Rate Plan Charge.\n"
}
}
}
],
"description": "Order Delta Tcb. This is a metric that reflects the change to the estimated billing on Rate Plan Charge object, or the estimated billing for an Order Line Item as the result of the order\n"
}
OrderDeltaTcv
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/OrderDeltaMetric"
},
{
"type": "object",
"properties": {
"orderLineItemId": {
"type": "string",
"format": "UUID",
"description": "The sytem generated Id for the Order Line Item. This field can be null if the metric is generated for subscriptions.\n"
}
}
}
],
"description": "Order Delta Tcv. This is a metric that reflects the change to the TCV on Rate Plan Charge object, or the Total Contracted Value for an Order Line Item as the result of the order\n"
}
OrderItem
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the order item."
},
"scId": {
"type": "string",
"description": "The ID of the charge segment that gets newly generated when the order item is created."
},
"endDate": {
"type": "string",
"format": "date",
"description": "The order item's effective end date, aligned with the end date of an increased quantity order metrics."
},
"quantity": {
"type": "number",
"description": "The order item quantity. For the usage charge type, the value of this field is always zero. Also, the Owner Transfer order action always creates an order item whose Quantity field is zero."
},
"startDate": {
"type": "string",
"format": "date",
"description": "The order item's effective start date, aligned with the start date of an increased quantity order metrics."
},
"orderActionId": {
"type": "string",
"description": "Specify the order action that creates this order item."
}
},
"description": "Represents an order item. An order item is a sales item within an order in the context of the recurring subscription business model. It can be a unit of products or a service, but defined by both quantity and term (the start and end dates). \n\nFor the one time and the recurring charge types, if an order action causes a quantity metric creation (when the delta quantity equals to or is greater than zero), an order item is created.\n\nThe following order actions will create an order item for the one time and recurring charges. The other order actions will refer to an existing order item. Also, the Owner Transfer order action always creates an order item whose quantity field is zero.\n\n * Create Subscription\n * Terms and Conditions - Extend Term\n * Renewal\n * Update Product - Increase Quantity\n * Add product\n * Owner Transfer\n\nFor the usage charge type, if the order action causes a usage increase, an order item is created, and the quantity field of the order item is always zero.\n\nThe following order actions will create an order item for for the usage charges.\n\n * Create Subscription\n * Terms and Conditions - Extend Term\n * Renewal\n * Add product\n * Owner Transfer\n"
}
OrderLineItem
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "UUID",
"description": "The sytem generated Id for the Order Line Item.\n"
},
"amount": {
"type": "number",
"description": "The calculated gross amount for the Order Line Item.\n"
},
"amountWithoutTax": {
"type": "number",
"description": "The calculated gross amount for an order line item excluding tax. If the tax mode is tax exclusive, the value of this field equals that of the `amount` field.\n\nIf the tax mode of an order line item is not set, the system treats it as tax exclusive by default. The value of the `amountWithoutTax` field equals that of the `amount` field.\n\nIf you create an order line item from the product catalog, the tax mode and tax code of the product rate plan charge are used for the order line item by default. You can still overwrite this default set-up by setting the tax mode and tax code of the order line item.\n"
},
"quantityFulfilled": {
"type": "number",
"description": "The quantity that has been fulfilled by fulfillments for the order line item. This field will be updated automatically when related fulfillments become 'SentToBilling' or 'Complete' state.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"maxLength": 255,
"description": "The number of the invoice group associated with the order line item.\n\nAfter enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"quantityPendingFulfillment": {
"type": "number",
"description": "The quantity that needs to be fulfilled by fulfillments for the order line item. This field will be updated automatically when related fulfillments become 'SentToBilling' or 'Complete' state.\n"
}
}
},
{
"$ref": "#/components/schemas/OrderLineItemCommonRetrieveOrderLineItem"
},
{
"type": "object",
"properties": {
"fulfillments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FulfillmentGet"
},
"description": "Container for the fulfillments attached to an order line item.\n"
}
}
}
]
}
OrderLineItemCommon
{
"type": "object",
"title": "OrderLineItem",
"properties": {
"UOM": {
"type": "string",
"description": "Specifies the units to measure usage.\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"billTo": {
"type": "string",
"description": "The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the bill-to contact of an order line item.\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"soldTo": {
"type": "string",
"description": "Use this field to assign an existing account as the sold-to contact of an order line item, by the following rules:\n\n* If the `ownerAccountNumber` field is set, then this field must be the ID of a contact that belongs to the owner account of the order line item. \n* If the `ownerAccountNumber` field is not set, then this field must be the ID of a contact that belongs to the billing account of the order line item.\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"taxCode": {
"type": "string",
"description": "The tax code for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"taxMode": {
"enum": [
"TaxInclusive",
"TaxExclusive"
],
"type": "string",
"description": "The tax mode for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"itemName": {
"type": "string",
"description": "The name of the Order Line Item (OLI).\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"itemType": {
"enum": [
"Product",
"Fee",
"Services"
],
"type": "string",
"description": "The type of the Order Line Item (OLI). \n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"quantity": {
"type": "number",
"description": "The quantity of units, such as the number of authors in a hosted wiki service.\n\nYou can update this field for a sales or return OLI only when the OLI in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"itemState": {
"enum": [
"Executing",
"Booked",
"SentToBilling",
"Complete",
"Cancelled"
],
"type": "string",
"description": "The state of the Order Line Item (OLI). See [State transitions for an order, order line item, and fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States) for more information.\n\nTo generate invoice for an OLI, you must set this field to `SentToBilling` and set the `billTargetDate` field .\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` or 'Booked' or `SentToBilling`state (when the `itemState` field is set as `Executing` or `SentToBilling`).\n"
},
"isUnbilled": {
"type": "boolean",
"description": "This field is used to dictate how to perform the accounting during revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"itemNumber": {
"type": "string",
"description": "The number for the Order Line Item (OLI).\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"billingRule": {
"enum": [
"TriggerWithoutFulfillment",
"TriggerAsFulfillmentOccurs"
],
"type": "string",
"default": "TriggerWithoutFulfillment",
"description": "The rule for billing of the Order Line Item (OLI).\n\nYou can update this field for a sales or return OLI only when it is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"description": {
"type": "string",
"description": "The description of the Order Line Item (OLI).\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"productCode": {
"type": "string",
"description": "The product code for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderLineItemCustomFields"
},
"amountPerUnit": {
"type": "number",
"description": "The actual charged amount per unit for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the orderLineItem.\n"
},
"accountingCode": {
"type": "string",
"description": "The accountingCode for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"billTargetDate": {
"type": "string",
"format": "date",
"description": "The target date for the Order Line Item (OLI) to be picked up by bill run for generating billing documents.\n\nTo generate billing documents for an OLI, you must set this field and set the `itemState` field to `SentToBilling`.\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"listPricePerUnit": {
"type": "number",
"description": "The list price per unit for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"inlineDiscountType": {
"enum": [
"Percentage",
"FixedAmount",
"None"
],
"type": "string",
"description": "You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n\nUse this field to specify the inline discount type, which can be `Percentage`, `FixedAmount`, or `None`. The default value is `Percentage`.\n\nUse this field together with the `inlineDiscountPerUnit` field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item. \n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"maxLength": 255,
"description": "The number of the invoice group associated with the order line item.\n\nAfter enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"ownerAccountNumber": {
"type": "string",
"description": "Use this field to assign an existing account as the owner of an order line item.\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"transactionEndDate": {
"type": "string",
"format": "date",
"description": "The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the `transactionStartDate` field.\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "Used by customers to specify the Purchase Order Number provided by the buyer.\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"isAllocationEligible": {
"type": "boolean",
"description": "This field is used to identify if the charge segment is allocation eligible in revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"transactionStartDate": {
"type": "string",
"format": "date",
"description": "The date a transaction starts. The default value of this field is the order date.\n\nYou can update this field for a sales or return OLI only when the OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"inlineDiscountPerUnit": {
"type": "number",
"description": "You can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n\nUse this field in accordance with the `inlineDiscountType` field, in the following manner:\n* If the `inlineDiscountType` field is set as `Percentage`, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify `5` in this field, the discount percentage is 5%.\n* If the `inlineDiscountType` field is set as `FixedAmount`, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify `10` in this field, the discount amount on each unit of the order line item is 10.\n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"
},
"revenueRecognitionRule": {
"type": "string",
"description": "The Revenue Recognition rule for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"revenueRecognitionTiming": {
"enum": [
"Upon Billing Document Posting Date",
"Upon Order Activation Date"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue recognition timing.\n\nPredefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"relatedSubscriptionNumber": {
"type": "string",
"description": "Use this field to relate an order line item to an subscription. Specify this field to the subscription number of the subscription to relate.\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"revenueAmortizationMethod": {
"enum": [
"Immediate",
"Ratable Using Start And End Dates"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue amortization method.\n\nPredefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"contractAssetAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The deferred revenue accounting code for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The recognized revenue accounting code for the Order Line Item (OLI).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"unbilledReceivablesAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n\nYou can update this field only for a sales OLI and only when the sales OLI is in the `Executing` state (when the `itemState` field is set as `Executing`).\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"description": "Indicates whether to exclude the related rate plan charges and order line items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.\n"
}
}
}
OrderLineItemCommonPostOrder
{
"type": "object",
"title": "OrderLineItem",
"properties": {
"UOM": {
"type": "string",
"description": "Specifies the units to measure usage.\n"
},
"billTo": {
"type": "string",
"description": "The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the bill-to contact of an order line item.\n"
},
"soldTo": {
"type": "string",
"description": "Use this field to assign an existing account as the sold-to contact of an order line item, by the following rules:\n\n* If the `ownerAccountNumber` field is set, then this field must be the ID of a contact that belongs to the owner account of the order line item. \n* If the `ownerAccountNumber` field is not set, then this field must be the ID of a contact that belongs to the billing account of the order line item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code for the Order Line Item.\n"
},
"taxMode": {
"enum": [
"TaxInclusive",
"TaxExclusive"
],
"type": "string",
"description": "The tax mode for the Order Line Item.\n"
},
"currency": {
"type": "string",
"description": "The currency for the order line item. You can specify a currency when creating an order line item through the \"Create an order\" operation.\n"
},
"itemName": {
"type": "string",
"description": "The name of the Order Line Item.\n"
},
"itemType": {
"enum": [
"Product",
"Fee",
"Services"
],
"type": "string",
"description": "The type of the Order Line Item. \n"
},
"quantity": {
"type": "number",
"description": "The quantity of units, such as the number of authors in a hosted wiki service.\n"
},
"itemState": {
"enum": [
"Executing",
"Booked",
"SentToBilling",
"Complete",
"Cancelled"
],
"type": "string",
"description": "The state of an Order Line Item. If you want to generate billing documents for order line items, you must set this field to `SentToBilling`. For invoice preview, you do not need to set this field.\n\nSee [State transitions for an order, order line item, and fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States) for more information.\n"
},
"isUnbilled": {
"type": "boolean",
"description": "This field is used to dictate how to perform the accounting during revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"itemNumber": {
"type": "string",
"description": "The number of the Order Line Item. Use this field to specify a custom item number for your Order Line Item. If you are to use this field, you must set all the item numbers in an order when there are several order line items in the order.\n"
},
"billingRule": {
"enum": [
"TriggerWithoutFulfillment",
"TriggerAsFulfillmentOccurs"
],
"type": "string",
"default": "TriggerWithoutFulfillment",
"description": "The billing rule for the Order Line Item.\n"
},
"description": {
"type": "string",
"description": "The description of the Order Line Item.\n"
},
"productCode": {
"type": "string",
"description": "The product code for the Order Line Item.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderLineItemCustomFields"
},
"itemCategory": {
"enum": [
"Sales",
"Return"
],
"type": "string",
"default": "Sales",
"description": "The category for the Order Line Item, to indicate a product sale or return.\n"
},
"amountPerUnit": {
"type": "number",
"description": "The actual charged amount per unit for the Order Line Item.\n\nIf you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the OrderLineItem.\n"
},
"accountingCode": {
"type": "string",
"description": "The accounting code for the Order Line Item.\n"
},
"billTargetDate": {
"type": "string",
"format": "date",
"description": "The target date for the Order Line Item to be picked up by bill run for billing.\n"
},
"listPricePerUnit": {
"type": "number",
"description": "The list price per unit for the Order Line Item.\n"
},
"inlineDiscountType": {
"enum": [
"Percentage",
"FixedAmount",
"None"
],
"type": "string",
"description": "Use this field to specify the inline discount type, which can be `Percentage`, `FixedAmount`, or `None`. The default value is `Percentage`.\n\nUse this field together with the `inlineDiscountPerUnit` field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item. \n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"maxLength": 255,
"description": "The number of the invoice group associated with the order line item.\n\nAfter enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"ownerAccountNumber": {
"type": "string",
"description": "Use this field to assign an existing account as the owner of an order line item.\n"
},
"transactionEndDate": {
"type": "string",
"format": "date",
"description": "The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the `transactionStartDate` field.\n"
},
"originalOrderNumber": {
"type": "string",
"description": "The number of the original sale order for a return order line item. \n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "Used by customers to specify the Purchase Order Number provided by the buyer.\n"
},
"isAllocationEligible": {
"type": "boolean",
"description": "This field is used to identify if the charge segment is allocation eligible in revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"transactionStartDate": {
"type": "string",
"format": "date",
"description": "The date a transaction starts. The default value of this field is the order date.\n"
},
"inlineDiscountPerUnit": {
"type": "number",
"description": "Use this field in accordance with the `inlineDiscountType` field, in the following manner:\n* If the `inlineDiscountType` field is set as `Percentage`, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify `5` in this field, the discount percentage is 5%.\n* If the `inlineDiscountType` field is set as `FixedAmount`, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify `10` in this field, the discount amount on each unit of the order line item is 10.\n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"
},
"revenueRecognitionRule": {
"type": "string",
"description": "The Revenue Recognition rule for the Order Line Item.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "Id of a Product Rate Plan Charge. Only one-time charges are supported.\n"
},
"revenueRecognitionTiming": {
"enum": [
"Upon Billing Document Posting Date",
"Upon Order Activation Date"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue recognition timing.\n\nPredefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"relatedSubscriptionNumber": {
"type": "string",
"description": "Use this field to relate an order line item to a subscription when you create the order line item.\n\n* To relate an order line item to a new subscription which is yet to create in the same \"Create an order\" call, use this field in combination with the `subscriptions` > `subscriptionNumber` field in the \"Create an order\" operation. Specify this field to the same value as that of the `subscriptions` > `subscriptionNumber` field when you make the \"Create an order\" call.\n* To relate an order line item to an existing subscription, specify this field to the subscription number of the existing subscription.\n"
},
"revenueAmortizationMethod": {
"enum": [
"Immediate",
"Ratable Using Start And End Dates"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue amortization method.\n\nPredefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"contractAssetAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"originalOrderLineItemNumber": {
"type": "string",
"description": "The number of the original sale order line item for a return order line item. \n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The deferred revenue accounting code for the Order Line Item.\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The recognized revenue accounting code for the Order Line Item.\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"unbilledReceivablesAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude Order Line Item from revenue accounting.\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled.\n"
}
}
}
OrderLineItemCommonRetrieveOrder
{
"type": "object",
"title": "OrderLineItem",
"properties": {
"UOM": {
"type": "string",
"description": "Specifies the units to measure usage.\n"
},
"billTo": {
"type": "string",
"description": "The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the bill-to contact of an order line item.\n"
},
"soldTo": {
"type": "string",
"description": "The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the sold-to contact of an order line item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code for the Order Line Item.\n"
},
"taxMode": {
"enum": [
"TaxInclusive",
"TaxExclusive"
],
"type": "string",
"description": "The tax mode for the Order Line Item.\n"
},
"currency": {
"type": "string",
"description": "The currency for the order line item. You can specify a currency when creating an order line item through the \"Create an order\" operation.\n"
},
"discount": {
"type": "number",
"description": "This field shows the total discount amount that is applied to an order line item after the `inlineDiscountType`, `inlineDiscountPerUnit` and `quantity` fields are set.\n\nThe inline discount is applied to the list price of an order line item (see the `listPrice` field).\n"
},
"itemName": {
"type": "string",
"description": "The name of the Order Line Item.\n"
},
"itemType": {
"enum": [
"Product",
"Fee",
"Services"
],
"type": "string",
"description": "The type of the Order Line Item. \n"
},
"quantity": {
"type": "number",
"description": "The quantity of units, such as the number of authors in a hosted wiki service.\n"
},
"itemState": {
"enum": [
"Executing",
"Booked",
"SentToBilling",
"Complete",
"Cancelled"
],
"type": "string",
"description": "The state of an Order Line Item. See [State transitions for an order, order line item, and fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States) for more information.\n"
},
"listPrice": {
"type": "number",
"description": "The extended list price for an order line item, calculated by the formula: listPrice = listPricePerUnit * quantity\n"
},
"isUnbilled": {
"type": "boolean",
"description": "This field is used to dictate how to perform the accounting during revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"billingRule": {
"enum": [
"TriggerWithoutFulfillment",
"TriggerAsFulfillmentOccurs"
],
"type": "string",
"description": "The billing rule of the Order Line Item.\n"
},
"description": {
"type": "string",
"description": "The description of the Order Line Item.\n"
},
"productCode": {
"type": "string",
"description": "The product code for the Order Line Item.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderLineItemCustomFields"
},
"itemCategory": {
"enum": [
"Sales",
"Return"
],
"type": "string",
"default": "Sales",
"description": "The category of the Order Line Item, to indicate a product sale or return.\n"
},
"amountPerUnit": {
"type": "number",
"description": "The actual charged amount per unit for the Order Line Item.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the OrderLineItem.\n"
},
"accountingCode": {
"type": "string",
"description": "The accounting code for the Order Line Item.\n"
},
"billTargetDate": {
"type": "string",
"format": "date",
"description": "The target date for the Order Line Item to be picked up by bill run for billing.\n"
},
"ownerAccountId": {
"type": "string",
"description": "The account ID of the owner of the order line item.\n"
},
"originalOrderId": {
"type": "string",
"description": "The ID of the original sale order for a return order line item. \n"
},
"billToSnapshotId": {
"type": "string",
"description": "The snapshot of the ID for an account used as the bill-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `billToSnapshotId` field is exposed while retrieving the order line item details.\n"
},
"listPricePerUnit": {
"type": "number",
"description": "The list price per unit for the Order Line Item.\n"
},
"ownerAccountName": {
"type": "string",
"description": "The account name of the owner of the order line item.\n"
},
"soldToSnapshotId": {
"type": "string",
"description": "The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `soldToSnapshotId` field is exposed while retrieving the order line item details.\n"
},
"quantityFulfilled": {
"type": "number",
"description": "The fulfilled quantity for an order line item.\n"
},
"inlineDiscountType": {
"enum": [
"Percentage",
"FixedAmount",
"None"
],
"type": "string",
"description": "This field is used to specify the inline discount type, which can be `Percentage`, `FixedAmount`, or `None`. The default value is `Percentage`.\n\nThis field is used together with the `inlineDiscountPerUnit` field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item. \n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"
},
"ownerAccountNumber": {
"type": "string",
"description": "The account number of the owner of the order line item.\n"
},
"transactionEndDate": {
"type": "string",
"format": "date",
"description": "The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the `transactionStartDate` field.\n"
},
"originalOrderNumber": {
"type": "string",
"description": "The number of the original sale order for a return order line item. \n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "Used by customers to specify the Purchase Order Number provided by the buyer.\n"
},
"requiresFulfillment": {
"type": "boolean",
"description": "The flag to show whether fulfillment is needed or not. It's derived from billing rule of the Order Line Item.\n"
},
"isAllocationEligible": {
"type": "boolean",
"description": "This field is used to identify if the charge segment is allocation eligible in revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"transactionStartDate": {
"type": "string",
"format": "date",
"description": "The date a transaction starts. The default value of this field is the order date.\n"
},
"inlineDiscountPerUnit": {
"type": "number",
"description": "This field is used in accordance with the `inlineDiscountType` field, in the following manner:\n* If the `inlineDiscountType` field is set as `Percentage`, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify `5` in this field, the discount percentage is 5%.\n* If the `inlineDiscountType` field is set as `FixedAmount`, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify `10` in this field, the discount amount on each unit of the order line item is 10.\n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"
},
"invoiceOwnerAccountId": {
"type": "string",
"description": "The account ID of the invoice owner of the order line item.\n"
},
"revenueRecognitionRule": {
"type": "string",
"description": "The Revenue Recognition rule for the Order Line Item.\n"
},
"invoiceOwnerAccountName": {
"type": "string",
"description": "The account name of the invoice owner of the order line item.\n"
},
"originalOrderLineItemId": {
"type": "string",
"description": "The ID of the original sale order line item for a return order line item. \n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "Id of a Product Rate Plan Charge. Only one-time charges are supported.\n"
},
"revenueRecognitionTiming": {
"enum": [
"Upon Billing Document Posting Date",
"Upon Order Activation Date"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue recognition timing.\n\nPredefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"invoiceOwnerAccountNumber": {
"type": "string",
"description": "The account number of the invoice owner of the order line item.\n"
},
"relatedSubscriptionNumber": {
"type": "string",
"description": "Use this field to relate an order line item to a subscription when you create the order line item.\n\n* To relate an order line item to a new subscription which is yet to create in the same \"Create an order\" call, use this field in combination with the `subscriptions` > `subscriptionNumber` field in the \"Create order\" operation. Specify this field to the same value as that of the 'subscriptions' > `subscriptionNumber` field when you make the \"Create order\" call.\n* To relate an order line item to an existing subscription, specify this field to the subscription number of the existing subscription.\n"
},
"revenueAmortizationMethod": {
"enum": [
"Immediate",
"Ratable Using Start And End Dates"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue amortization method.\n\nPredefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"quantityAvailableForReturn": {
"type": "number",
"description": "The quantity that can be returned for an order line item. \n"
},
"quantityPendingFulfillment": {
"type": "number",
"description": "The quantity to fulfill for an order line item. \n"
},
"contractAssetAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"originalOrderLineItemNumber": {
"type": "string",
"description": "The number of the original sale order line item for a return order line item. \n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The deferred revenue accounting code for the Order Line Item.\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The recognized revenue accounting code for the Order Line Item.\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"unbilledReceivablesAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude Order Line Item from revenue accounting.\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
}
}
}
OrderLineItemCommonRetrieveOrderLineItem
{
"type": "object",
"title": "OrderLineItem",
"properties": {
"UOM": {
"type": "string",
"description": "Specifies the units to measure usage.\n"
},
"billTo": {
"type": "string",
"description": "The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the bill-to contact of an order line item.\n"
},
"soldTo": {
"type": "string",
"description": "The ID of a contact that belongs to the owner account or billing account of the order line item. Use this field to assign an existing account as the sold-to contact of an order line item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code for the Order Line Item.\n"
},
"taxMode": {
"enum": [
"TaxInclusive",
"TaxExclusive"
],
"type": "string",
"description": "The tax mode for the Order Line Item.\n"
},
"currency": {
"type": "string",
"description": "The currency for the order line item. You can specify a currency when creating an order line item through the \"Create an order\" operation.\n"
},
"discount": {
"type": "number",
"description": "This field shows the total discount amount that is applied to an order line item after the `inlineDiscountType`, `inlineDiscountPerUnit` and `quantity` fields are set.\n\nThe inline discount is applied to the list price of an order line item (see the `listPrice` field).\n"
},
"itemName": {
"type": "string",
"description": "The name of the Order Line Item.\n"
},
"itemType": {
"enum": [
"Product",
"Fee",
"Services"
],
"type": "string",
"description": "The type of the Order Line Item. \n"
},
"quantity": {
"type": "number",
"description": "The quantity of units, such as the number of authors in a hosted wiki service.\n"
},
"itemState": {
"enum": [
"Executing",
"Booked",
"SentToBilling",
"Complete",
"Cancelled"
],
"type": "string",
"description": "The state of the Order Line Item. See [State transitions for an order, order line item, and fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States) for more information.\n"
},
"listPrice": {
"type": "number",
"description": "The extended list price for an order line item, calculated by the formula: listPrice = listPricePerUnit * quantity\n"
},
"isUnbilled": {
"type": "boolean",
"description": "This field is used to dictate how to perform the accounting during revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"itemNumber": {
"type": "string",
"description": "The number for the Order Line Item.\n"
},
"billingRule": {
"enum": [
"TriggerWithoutFulfillment",
"TriggerAsFulfillmentOccurs"
],
"type": "string",
"description": "The billing rule for the Order Line Item.\n"
},
"description": {
"type": "string",
"description": "The description of the Order Line Item.\n"
},
"productCode": {
"type": "string",
"description": "The product code for the Order Line Item.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderLineItemCustomFieldsRetrieveOrderLineItem"
},
"itemCategory": {
"enum": [
"Sales",
"Return"
],
"type": "string",
"default": "Sales",
"description": "The category for the Order Line Item, to indicate a product sales or return.\n"
},
"amountPerUnit": {
"type": "number",
"description": "The actual charged amount per unit for the Order Line Item.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the OrderLineItem.\n"
},
"accountingCode": {
"type": "string",
"description": "The accountingCode for the Order Line Item.\n"
},
"billTargetDate": {
"type": "string",
"format": "date",
"description": "The target date for the Order Line Item to be picked up by bill run for billing.\n"
},
"ownerAccountId": {
"type": "string",
"description": "The account ID of the owner of the order line item.\n"
},
"originalOrderId": {
"type": "string",
"description": "The ID of the original sales order for a return order line item.\n"
},
"amendedByOrderOn": {
"type": "string",
"format": "date",
"description": "The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sales order line in Zuora Revenue.\n"
},
"billToSnapshotId": {
"type": "string",
"description": "The snapshot of the ID for an account used as the bill-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `billToSnapshotId` field is exposed while retrieving the order line item details.\n"
},
"listPricePerUnit": {
"type": "number",
"description": "The list price per unit for the Order Line Item.\n"
},
"ownerAccountName": {
"type": "string",
"description": "The account name of the owner of the order line item.\n"
},
"soldToSnapshotId": {
"type": "string",
"description": "The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `soldToSnapshotId` field is exposed while retrieving the order line item details.\n"
},
"originalOrderDate": {
"type": "string",
"format": "date",
"description": "The date when the rate plan charge is created through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sales order line in Zuora Revenue.\n"
},
"quantityFulfilled": {
"type": "number",
"description": "The fulfilled quantity for an order line item. \n"
},
"inlineDiscountType": {
"enum": [
"Percentage",
"FixedAmount",
"None"
],
"type": "string",
"description": "This field is used to specify the inline discount type, which can be `Percentage`, `FixedAmount`, or `None`. The default value is `Percentage`.\n\nThis field is used together with the `inlineDiscountPerUnit` field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item. \n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"
},
"ownerAccountNumber": {
"type": "string",
"description": "The account number of the owner of the order line item.\n"
},
"transactionEndDate": {
"type": "string",
"format": "date",
"description": "The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the `transactionStartDate` field.\n"
},
"originalOrderNumber": {
"type": "string",
"description": "The number of the original sales order for a return order line item.\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "Used by customers to specify the Purchase Order Number provided by the buyer.\n"
},
"requiresFulfillment": {
"type": "boolean",
"description": "The flag to show whether fulfillment is needed or not. It's derived from billing rule of the Order Line Item.\n"
},
"isAllocationEligible": {
"type": "boolean",
"description": "This field is used to identify if the charge segment is allocation eligible in revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"transactionStartDate": {
"type": "string",
"format": "date",
"description": "The date a transaction starts. The default value of this field is the order date.\n"
},
"inlineDiscountPerUnit": {
"type": "number",
"description": "This field is used in accordance with the `inlineDiscountType` field, in the following manner:\n* If the `inlineDiscountType` field is set as `Percentage`, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify `5` in this field, the discount percentage is 5%.\n* If the `inlineDiscountType` field is set as `FixedAmount`, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify `10` in this field, the discount amount on each unit of the order line item is 10.\n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"
},
"invoiceOwnerAccountId": {
"type": "string",
"description": "The account ID of the invoice owner of the order line item.\n"
},
"revenueRecognitionRule": {
"type": "string",
"description": "The Revenue Recognition rule for the Order Line Item.\n"
},
"invoiceOwnerAccountName": {
"type": "string",
"description": "The account name of the invoice owner of the order line item.\n"
},
"originalOrderLineItemId": {
"type": "string",
"description": "The ID of the original sales order line item for a return order line item.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "Id of a Product Rate Plan Charge. Only one-time charges are supported.\n"
},
"revenueRecognitionTiming": {
"enum": [
"Upon Billing Document Posting Date",
"Upon Order Activation Date"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue recognition timing.\n\nPredefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"invoiceOwnerAccountNumber": {
"type": "string",
"description": "The account number of the invoice owner of the order line item.\n"
},
"relatedSubscriptionNumber": {
"type": "string",
"description": "Use this field to relate an order line item to an subscription. Specify this field to the subscription number of the subscription to relate.\n"
},
"revenueAmortizationMethod": {
"enum": [
"Immediate",
"Ratable Using Start And End Dates"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue amortization method.\n\nPredefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"quantityAvailableForReturn": {
"type": "number",
"description": "The quantity that can be returned for an order line item. \n"
},
"quantityPendingFulfillment": {
"type": "number",
"description": "The quantity to fulfill for an order line item. \n"
},
"contractAssetAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"originalOrderLineItemNumber": {
"type": "string",
"description": "The number of the original sales order line item for a return order line item.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The deferred revenue accounting code for the Order Line Item.\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The recognized revenue accounting code for the Order Line Item.\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"unbilledReceivablesAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude Order Line Item from revenue accounting.\n\n**Note**: This field is only available if you have the [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"
}
}
}
OrderLineItemCustomFields
{
"type": "object",
"title": "OrderLineItemCustomFields",
"description": "Container for custom fields of an Order Line Item object.\n",
"additionalProperties": {
"description": "Custom fields of the Order Line Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
OrderLineItemCustomFieldsRetrieveOrderLineItem
{
"type": "object",
"title": "OrderLineItemCustomFields",
"description": "Container for custom fields of an Order Line Item object.\n",
"additionalProperties": {
"description": "Custom fields of the Order Line Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
OrderLineItemRetrieveOrder
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "UUID",
"description": "The sytem generated Id for the Order Line Item.\n"
},
"amount": {
"type": "number",
"description": "The calculated gross amount for the Order Line Item.\n"
},
"itemNumber": {
"type": "string",
"description": "The number for the Order Line Item.\n"
},
"amendedByOrderOn": {
"type": "string",
"description": "The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n"
},
"amountWithoutTax": {
"type": "number",
"description": "The calculated gross amount for an order line item excluding tax. If the tax mode is tax exclusive, the value of this field equals that of the `amount` field.\n\nIf the tax mode of an order line item is not set, the system treats it as tax exclusive by default. The value of the `amountWithoutTax` field equals that of the `amount` field.\n\nIf you create an order line item from the product catalog, the tax mode and tax code of the product rate plan charge are used for the order line item by default. You can still overwrite this default set-up by setting the tax mode and tax code of the order line item.\n"
},
"originalOrderDate": {
"type": "string",
"format": "date",
"description": "The date when the rate plan charge is created through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n"
},
"quantityFulfilled": {
"type": "number",
"description": "The quantity that has been fulfilled by fulfillments for the order line item. This field will be updated automatically when related fulfillments become 'SentToBilling' or 'Complete' state.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"description": "The number of the invoice group associated with the order line item. \n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"quantityPendingFulfillment": {
"type": "number",
"description": "The quantity that's need to be fulfilled by fulfillments for the order line item. This field will be updated automatically when related fulfillments become 'SentToBilling' or 'Complete' state.\n"
}
}
},
{
"$ref": "#/components/schemas/OrderLineItemCommonRetrieveOrder"
}
]
}
OrderObjectCustomFields
{
"type": "object",
"title": "orderFieldsCustom",
"description": "Container for custom fields of an Order object.\n",
"additionalProperties": {
"description": "Custom fields of the Order object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
OrderRampIntervalMetrics
{
"type": "object",
"title": "RampIntervalMetrics",
"properties": {
"name": {
"type": "string",
"description": "The name of the interval."
},
"netTcb": {
"type": "number",
"description": "The net TCB value after discount charges are applied."
},
"netTcv": {
"type": "number",
"description": "The net TCV value after discount charges are applied."
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date of the interval."
},
"grossTcb": {
"type": "number",
"description": "The gross TCB value before discount charges are applied."
},
"grossTcv": {
"type": "number",
"description": "The gross TCV value before discount charges are applied."
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the interval."
},
"description": {
"type": "string",
"description": "The short description of the interval."
},
"discountTcb": {
"type": "number",
"description": "The discount amount for the TCB."
},
"discountTcv": {
"type": "number",
"description": "The discount amount for the TCV."
},
"intervalMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RampIntervalChargeMetrics"
},
"description": "Container for the detailed metrics for each rate plan charge in each ramp interval."
},
"intervalDeltaMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RampIntervalChargeDeltaMetrics"
},
"description": "Container for the delta metrics for each rate plan charge in each ramp interval. The delta is the difference of the subscription metrics between before and after the order."
}
}
}
OrderRampMetrics
{
"type": "object",
"title": "RampMetrics",
"properties": {
"name": {
"type": "string",
"description": "The name of the ramp."
},
"netTcb": {
"type": "number",
"description": "The net TCB value after discount charges are applied."
},
"netTcv": {
"type": "number",
"description": "The net TCV value after discount charges are applied."
},
"number": {
"type": "string",
"description": "The number of the ramp. It is automaticcally generated by the billing system."
},
"grossTcb": {
"type": "number",
"description": "The gross TCB value before discount charges are applied."
},
"grossTcv": {
"type": "number",
"description": "The gross TCV value before discount charges are applied."
},
"intervals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderRampIntervalMetrics"
},
"description": "The ramp metrics for each ramp intervals in its timeline."
},
"description": {
"type": "string",
"description": "The short description of the ramp."
},
"discountTcb": {
"type": "number",
"description": "The discount amount for the TCB."
},
"discountTcv": {
"type": "number",
"description": "The discount amount for the TCV."
}
}
}
OrdersRatePlanObjectCustomFields
{
"type": "object",
"title": "ratePlanFieldsCustom",
"description": "Container for custom fields of the Rate Plan or Subscription Offer object. The custom fields of the Rate Plan object are used when rate plans are subscribed, and the custom fields of the Subscription Offer object are used when product offers are subscribed.\n",
"additionalProperties": {
"description": "Custom fields of the Rate Plan or Subscription Offer object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
OwnerTransfer
{
"type": "object",
"title": "ownerTransfer",
"properties": {
"paymentTerm": {
"type": "string",
"description": "Name of the payment term associated with the account. For example, \"Net 30\". The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"billToContactId": {
"type": "string",
"description": "The contact id of the bill to contact that the subscription is being transferred to.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"maxLength": 255,
"description": "The number of the invoice group associated with the subscription.\n\nAfter enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"destinationAccountNumber": {
"type": "string",
"description": "The account number of the account that the subscription is being transferred to.\n"
},
"clearingExistingPaymentTerm": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingSequenceSet": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingBillToContact": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingSoldToContact": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingInvoiceTemplate": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"destinationInvoiceAccountNumber": {
"type": "string",
"description": "The account number of the invoice owner account that the subscription is being transferred to.\n"
},
"clearingExistingInvoiceGroupNumber": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
}
},
"description": "Information about an order action of type `OwnerTransfer`.\n\n**Note:** The Owner Transfer 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"
}
POSTAccountPMMandateInfo
{
"type": "object",
"title": "mandateInfo",
"properties": {
"mandateId": {
"type": "string",
"description": "The mandate ID.\n"
},
"mandateReason": {
"type": "string",
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"description": "The status of the mandate from the gateway side.\n"
},
"mitProfileType": {
"type": "string",
"description": "Indicates the type of the stored credential profile. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field.\n"
},
"mitProfileAction": {
"enum": [
"Activate",
"Persist"
],
"type": "string",
"description": "Specifies how Zuora creates and activates the stored credential profile. Only applicable if you set the `status` field to `Active`.\n\n* `Activate` (default) - Use this value if you are creating the stored credential profile after receiving the customer's consent.\n\n Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile.\n \n If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`.\n\n\n* `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`.\n\nIf you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field.\n"
},
"mitTransactionId": {
"type": "string",
"maxLength": 128,
"description": "Specifies the ID of the transaction. Only applicable if you set the `mitProfileAction` field to `Persist`.\n"
},
"mandateUpdateDate": {
"type": "string",
"format": "date",
"description": "The date on which the mandate was updated.\n"
},
"mitProfileAgreedOn": {
"type": "string",
"format": "date",
"description": "The date on which the stored credential profile is agreed. The date format is `yyyy-mm-dd`.\n"
},
"mandateCreationDate": {
"type": "string",
"format": "date",
"description": "The date on which the mandate was created.\n"
},
"existingMandateStatus": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Indicates whether the mandate is an existing mandate.\n"
},
"mandateReceivedStatus": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Indicates whether the mandate is received from the gateway\n"
},
"mitConsentAgreementRef": {
"type": "string",
"description": "Reference for the consent agreement that you have established with the customer. \n"
},
"mitConsentAgreementSrc": {
"enum": [
"External"
],
"type": "string",
"description": "Required if you set the `mitProfileAction` field. Specify how the consent agreement has been established with the customer. The allowed value is `External`. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field.\n"
}
},
"description": "The mandate information for the Credit Card, Apple Pay, Google Pay, Credit Card Reference Transaction, ACH, or Bank Transfer payment method.\n\nThe following mandate fields are common to all supported payment methods:\n* `mandateId`\n* `mandateReason`\n* `mandateStatus`\n\nThe following mandate fields are specific to the ACH and Bank Transfer payment methods:\n* `mandateReceivedStatus`\n* `existingMandateStatus`\n* `mandateCreationDate`\n* `mandateUpdateDate`\n\nThe following mandate fields are specific to the Credit Card, Apple Pay, and Google Pay payment methods:\n* `mitTransactionId`\n* `mitProfileAgreedOn`\n* `mitConsentAgreementRef`\n* `mitConsentAgreementSrc`\n* `mitProfileType`\n* `mitProfileAction`\n"
}
POSTAccountResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"accountId": {
"type": "string",
"description": "Auto-generated account ID.\n"
},
"invoiceId": {
"type": "string",
"description": "ID of the invoice generated at account creation, if applicable.\n"
},
"paymentId": {
"type": "string",
"description": "ID of the payment collected on the invoice generated at account creation, if applicable.\n"
},
"paidAmount": {
"type": "string",
"format": "decimal",
"description": "Amount collected on the invoice generated at account creation, if applicable.\n"
},
"creditMemoId": {
"type": "string",
"description": "The credit memo ID, if a credit memo is generated during the subscription process.\n\n**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"accountNumber": {
"type": "string",
"description": "Account number.\n"
},
"contractedMrr": {
"type": "string",
"format": "decimal",
"description": "Contracted monthly recurring revenue of the subscription.\n"
},
"subscriptionId": {
"type": "string",
"description": "ID of the subscription that was set up at account creation, if applicable.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact.\n"
},
"paymentMethodId": {
"type": "string",
"description": "ID of the payment method that was set up at account creation, which automatically becomes the default payment method for this account.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "Number of the subscription that was set up at account creation, if applicable.\n"
},
"totalContractedValue": {
"type": "string",
"format": "decimal",
"description": "Total contracted value of the subscription.\n"
}
}
}
POSTAccountType
{
"allOf": [
{
"type": "object",
"required": [
"name",
"currency",
"billToContact"
],
"properties": {
"name": {
"type": "string",
"description": "Account name, up to 255 characters.\n"
},
"batch": {
"type": "string",
"description": "The alias name given to a batch. A string of 50 characters or\nless.\n\n**Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite\" target=\"_blank\">Performance Booster Elite</a> package.\n"
},
"crmId": {
"type": "string",
"description": "CRM account ID for the account, up to 100 characters.\n"
},
"notes": {
"type": "string",
"description": "A string of up to 65,535 characters."
},
"autoPay": {
"type": "boolean",
"description": "Whether future payments are to be automatically billed when they are due. \n\n- If this field is set to `true`, you must specify either the `creditCard` field or the `hpmCreditCardPaymentMethodId` field, but not both.\n- If this field is set to `false`, you can specify neither the `creditCard` field nor the `hpmCreditCardPaymentMethodId` field.\n"
},
"collect": {
"type": "boolean",
"default": true,
"description": "Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.\n\nIf the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.\n\nPrerequisite: The `invoice` or `runBilling` field must be `true`. \n\n**Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"invoice": {
"type": "boolean",
"default": true,
"description": "**Note:** This field has been replaced by the `runBilling` field. The\n`invoice` field is only available for backward compatibility. \n\nCreates an invoice for a subscription. The invoice generated in this\noperation is only for this subscription, not for the entire customer\naccount.\n\nIf the value is `true`, an invoice is created. If the value is\n`false`, no action is taken.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `196.0` or `207.0`.\n"
},
"tagging": {
"type": "string",
"description": ""
},
"taxInfo": {
"type": "object",
"properties": {
"VATId": {
"type": "string",
"description": "EU Value Added Tax ID. \n\n**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com).\n"
},
"companyCode": {
"type": "string",
"description": "Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara.\n\n**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). \n"
},
"exemptStatus": {
"type": "string",
"description": "Status of the account tax exemption. Requires Zuora Tax.\n\nRequired if you use Zuora Tax. This field is unavailable if Zuora Tax is not used.\n\nValues: `Yes`, `No`(default), `pendingVerification`. Note that the value will be set to `No` if no input.\n"
},
"exemptDescription": {
"type": "string",
"description": "Description of the tax exemption certificate that the customer holds. Requires Zuora Tax.\n"
},
"exemptCertificateId": {
"type": "string",
"description": "ID of the customer tax exemption certificate. Requires Zuora Tax.\n"
},
"exemptEffectiveDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption starts. Requires Zuora Tax.\n\nFormat: `yyyy-mm-dd`. Defaults to the current date.\n"
},
"exemptEntityUseCode": {
"type": "string",
"maxLength": 64,
"description": "A unique entity use code to apply exemptions in Avalara AvaTax.\n\nThis account-level field is required only when you choose Avalara as your tax engine. See [Exempt Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for more details.\n"
},
"exemptExpirationDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption expires. Requires Zuora Tax.\n\nFormat: `yyyy-mm-dd`. Defaults to the current date.\n"
},
"exemptCertificateType": {
"type": "string",
"description": "Type of tax exemption certificate that the customer holds. Requires Zuora Tax.\n"
},
"exemptIssuingJurisdiction": {
"type": "string",
"description": "Jurisdiction in which the customer tax exemption certificate was issued.\n"
}
},
"description": "Container for tax exempt information, used to establish the tax exempt status of a customer account.\n"
},
"currency": {
"type": "string",
"description": "A currency as defined in Billing Settings in the Zuora UI.\n\nFor payment method authorization, if the `paymentMethod` > `currencyCode` field is specified, `currencyCode` is used. Otherwise, this `currency` field is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used.\n"
},
"parentId": {
"type": "string",
"description": "Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\" target=\"_blank\">Customer Hierarchy</a> enabled."
},
"salesRep": {
"type": "string",
"description": "The name of the sales representative associated with this account, if applicable. Maximum of 50 characters."
},
"creditCard": {
"$ref": "#/components/schemas/POSTAccountTypeCreditCard"
},
"runBilling": {
"enum": [
true,
false
],
"type": "boolean",
"default": true,
"description": "Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/B_Credit_and_Debit_Memos/Rules_for_generating_invoices_and_credit_memos). \n\n\nThe billing documents generated\nin this operation is only for this subscription, not for the entire\ncustomer account.\n\n\nPossible values:\n\n- `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.\n\n\n- `false`: No invoice is created.\n\n\n**Note:** This field is in Zuora REST API version control. Supported\nminor versions are `211.0` and later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). To use this field in the method,\nyou must set the `zuora-version` parameter to the minor version number\nin the request header.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date.\n\n**Note:** The credit memo is only available only if you have the Invoice Settlement feature enabled.\n\nThis field is in Zuora REST API version control. Supported minor versions are `211.0` and later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header.\n"
},
"applyCredit": {
"type": "boolean",
"description": "Whether to automatically apply credit memos or unapplied payments, or both to an invoice.\n\nIf the value is `true`, the credit memo or unapplied payment, or both will be automatically applied to the invoice. If no value is specified or the value is `false`, no action is taken.\n\n**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"paymentTerm": {
"type": "string",
"description": "Payment terms for this account. Possible values are: `Due Upon Receipt`, `Net 30`, `Net 60`, `Net 90`.\n\n**Note**: If you want to specify a payment term when creating a new account, you must set a value in this field. If you do not set a value in this field, Zuora will use `Due Upon Receipt` as the value instead of the default value set in **Billing Settings** > **Payment Terms** from Zuora UI.\n"
},
"billCycleDay": {
"type": "integer",
"format": "int64",
"description": "The account's bill cycle day (BCD), when bill runs generate invoices for the account. Specify any day of the month (1-31, where 31 = end-of-month), or 0 for auto-set.\n\nRequired if no subscription will be created. \n\nOptional if a subscription is created and defaults to the day-of-the-month of the subscription's `contractEffectiveDate`.\n"
},
"documentDate": {
"type": "string",
"format": "date",
"description": "The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.\n\n- If this field is specified, the specified date is used as the billing document date. \n- If this field is not specified, the date specified in the `targetDate` is used as the billing document date.\n"
},
"subscription": {
"$ref": "#/components/schemas/POSTAccountTypeSubscription"
},
"accountNumber": {
"type": "string",
"description": "A unique account number, up to 50 characters that do not begin with the default account number prefix. If no account number is specified, one is generated.\n"
},
"billToContact": {
"$ref": "#/components/schemas/POSTAccountTypeBillToContact"
},
"paymentMethod": {
"$ref": "#/components/schemas/POSTPaymentMethodRequest"
},
"profileNumber": {
"type": "string",
"description": "The number of the communication profile that this account is linked to.\n\nYou can provide either or both of the `communicationProfileId` and `profileNumber` fields.\n\nIf both are provided, the request will fail if they do not refer to the same communication profile.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the billing document sequence set to assign to the customer account. \n\nThe billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.\n\nIf a customer account has no assigned billing document sequence set, billing documents generated for this account adopt the prefix and starting document number from the default sequence set.\n"
},
"soldToContact": {
"$ref": "#/components/schemas/POSTAccountTypeSoldToContact"
},
"invoiceCollect": {
"type": "boolean",
"description": "**Note:** This field has been replaced by the `invoice` field\nand the `collect` field. `invoiceCollect` is available only for backward\ncompatibility.\n\n\nIf this field is set to `true`, and a subscription is created, an invoice is generated at account creation time and payment is immediately collected using the account's default payment method.\n\n\n**Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`. The default field value is `true`.\n"
},
"partnerAccount": {
"type": "boolean",
"default": false,
"description": "Whether the customer account is a partner, distributor, or reseller. \n\n\nYou can set this field to `true` if you have business with distributors or resellers, or operating in B2B model to manage numerous subscriptions through concurrent API requests. After this field is set to `true`, the calculation of account metrics is performed asynchronously during operations such as subscription creation, order changes, invoice generation, and payments.\n\n \n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account\" target=\"_blank\">Reseller Account</a> feature enabled.\n"
},
"paymentGateway": {
"type": "string",
"description": "The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.\n"
},
"einvoiceProfile": {
"$ref": "#/components/schemas/PostAccountEInvoiceProfile"
},
"applicationOrder": {
"type": "array",
"items": {
"type": "string"
},
"description": "The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.\n\n**Note:**\n - This field is valid only if the `applyCredit` field is set to `true`.\n - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.\n - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.\n"
},
"invoiceTargetDate": {
"type": "string",
"format": "date",
"description": "**Note:** This field has been replaced by the `targetDate` field. The\n`invoiceTargetDate` field is only available for backward\ncompatibility. \n\n\nDate through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.\n\n\nThis field is in REST API minor version control. To use this field in\nthe method, you can set the `zuora-version` parameter to the minor\nversion number in the request header. Supported minor versions are\n`207.0` and earlier [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). \n"
},
"invoiceTemplateId": {
"type": "string",
"description": "Invoice template ID, configured in Billing Settings in the Zuora UI.\n"
},
"organizationLabel": {
"type": "string",
"description": "Name of the organization that the account belongs to. \n\nThis field is only required when you have already turned on Multi-Org feature. \n"
},
"applyCreditBalance": {
"type": "boolean",
"description": "Applies a credit balance to an invoice.\n\nIf the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.\n\nPrerequisite: `invoice` must be `true`.\n\nTo view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.\n\n\n**Note:** \n - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.\n - This field is deprecated if you have the Invoice Settlement feature enabled. \n"
},
"soldToSameAsBillTo": {
"type": "boolean",
"description": "Whether the sold-to contact and bill-to contact are the same entity. \n\nThe created account has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body:\n\n- This field is set to `true`. \n- A bill-to contact is specified.\n- No sold-to contact is specified.\n"
},
"debitMemoTemplateId": {
"type": "string",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThe unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.\n"
},
"creditMemoReasonCode": {
"type": "string",
"description": "A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code."
},
"creditMemoTemplateId": {
"type": "string",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThe unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.\n"
},
"communicationProfileId": {
"type": "string",
"description": "The ID of the communication profile that this account is linked to.\n\nYou can provide either or both of the `communicationProfileId` and `profileNumber` fields.\n\nIf both are provided, the request will fail if they do not refer to the same communication profile.\n"
},
"additionalEmailAddresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of additional email addresses to receive email notifications. Use commas to separate email addresses.\n"
},
"invoiceDeliveryPrefsEmail": {
"type": "boolean",
"default": false,
"description": "Whether the customer wants to receive invoices through email. \n"
},
"invoiceDeliveryPrefsPrint": {
"type": "boolean",
"default": false,
"description": "Whether the customer wants to receive printed invoices, such as through postal mail.\n"
},
"hpmCreditCardPaymentMethodId": {
"type": "string",
"description": "The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.\n\nIf the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field, but not both.\n\nFor the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the `paymentMethod` field to create a CC Reference Transaction payment method for an account.\n"
}
}
},
{
"$ref": "#/components/schemas/AccountObjectNSFields"
},
{
"$ref": "#/components/schemas/AccountObjectCustomFields"
}
],
"example": {
"name": "Zuora Test Account",
"notes": "This account is for demo purposes.",
"autoPay": false,
"currency": "USD",
"paymentTerm": "Due Upon Receipt",
"billCycleDay": 0,
"subscription": {
"notes": "This is a trial subscription for POST account demo.",
"termType": "TERMED",
"autoRenew": true,
"initialTerm": 12,
"renewalTerm": 12,
"subscribeToRatePlans": [
{
"chargeOverrides": [
{
"price": 1000,
"productRatePlanChargeId": "2c92c0f94ac8307f014ae5d4a5156b28"
},
{
"price": 1000,
"productRatePlanChargeId": "2c92c0f94ac8307f014ae5dbe2947851"
}
],
"productRatePlanId": "2c92c0f94ac8307f014ae5d3d1d469e2"
},
{
"chargeOverrides": [
{
"price": 1000,
"productRatePlanChargeId": "2c92c0f83cf64298013d027725a67b7b"
}
],
"productRatePlanId": "2c92c0f93cf64d94013d027681560341"
}
],
"contractEffectiveDate": "2016-01-01"
},
"billToContact": {
"city": "Foster City",
"state": "CA",
"country": "United States",
"zipCode": "94404",
"address1": "1051 E Hillsdale Blvd",
"lastName": "Smith",
"firstName": "John",
"workEmail": "smith@example.com"
},
"partnerAccount": true,
"einvoiceProfile": {
"enabled": true,
"endpointId": "8992",
"businessName": "legal business name",
"businessNumber": "20002039",
"businessCategory": "B2B",
"endpointSchemeId": "88",
"taxRegisterNumber": "TAX393999",
"businessNumberSchemeId": "88"
},
"creditMemoReasonCode": "Unsatisfactory service",
"additionalEmailAddresses": [
"contact1@example.com",
"contact2@example.com"
],
"invoiceDeliveryPrefsEmail": true,
"invoiceDeliveryPrefsPrint": false,
"hpmCreditCardPaymentMethodId": "2c92c0f93cf64d94013cfe2d20db61a7"
}
}
POSTAccountTypeBillToContact
{
"allOf": [
{
"type": "object",
"required": [
"firstName",
"lastName"
],
"properties": {
"fax": {
"type": "string",
"description": "Fax phone number, 40 characters or less.\n"
},
"city": {
"type": "string",
"description": "City, 40 characters or less.\n"
},
"state": {
"type": "string",
"description": "State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided.\n"
},
"county": {
"type": "string",
"description": "County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax.\n"
},
"country": {
"type": "string",
"description": "Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.\n"
},
"zipCode": {
"type": "string",
"description": "Zip code, 20 characters or less.\n"
},
"address1": {
"type": "string",
"description": "First address line, 255 characters or less.\n"
},
"address2": {
"type": "string",
"description": "Second address line, 255 characters or less.\n"
},
"lastName": {
"type": "string",
"description": "Last name, 100 characters or less.\n"
},
"nickname": {
"type": "string",
"description": "Nickname for this contact\n"
},
"firstName": {
"type": "string",
"description": "First name, 100 characters or less.\n"
},
"homePhone": {
"type": "string",
"description": "Home phone number, 40 characters or less.\n"
},
"taxRegion": {
"type": "string",
"description": "If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n"
},
"workEmail": {
"type": "string",
"description": "Work email address, 80 characters or less.\n"
},
"workPhone": {
"type": "string",
"description": "Work phone number, 40 characters or less.\n"
},
"otherPhone": {
"type": "string",
"description": "Other phone number, 40 characters or less.\n"
},
"mobilePhone": {
"type": "string",
"description": "Mobile phone number, 40 characters or less.\n"
},
"personalEmail": {
"type": "string",
"description": "Personal email address, 80 characters or less.\n"
},
"otherPhoneType": {
"type": "string",
"description": "Possible values are: `Work`, `Mobile`, `Home`, `Other`.\n"
}
}
},
{
"$ref": "#/components/schemas/ContactObjectCustomFields"
}
],
"title": "Contact",
"description": "Container for bill-to contact information for this account. If you do not provide a sold-to contact, the bill-to contact is copied to sold-to contact. Once the sold-to contact is created, changes to billToContact will not affect soldToContact and vice versa.\n"
}
POSTAccountTypeCreditCard
{
"allOf": [
{
"type": "object",
"required": [
"cardHolderInfo",
"cardNumber",
"cardType",
"expirationMonth",
"expirationYear"
],
"properties": {
"cardType": {
"type": "string",
"description": "The type of the credit card.\n\nPossible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).\n"
},
"cardNumber": {
"type": "string",
"description": "Card number, up to 16 characters. Once created, this field can't be updated or queried, and is only available in masked format (e.g., XXXX-XXXX-XXXX-1234).\n"
},
"securityCode": {
"type": "string",
"description": "The CVV or CVV2 security code of the card. To ensure PCI compliance, this value is not stored and cannot be queried.\n"
},
"cardHolderInfo": {
"required": [
"addressLine1",
"cardHolderName",
"city",
"country",
"state",
"zipCode"
],
"properties": {
"city": {
"type": "string",
"description": "City, 40 characters or less.\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"email": {
"type": "string",
"description": "Card holder's email address, 80 characters or less.\n"
},
"phone": {
"type": "string",
"description": "Phone number, 40 characters or less.\n"
},
"state": {
"type": "string",
"description": "State; must be a valid state name or 2-character abbreviation.\n"
},
"country": {
"type": "string",
"description": "Country; must be a valid country name or abbreviation.\nIt is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.\n"
},
"zipCode": {
"type": "string",
"description": "Zip code, 20 characters or less.\n"
},
"addressLine1": {
"type": "string",
"description": "First address line, 255 characters or less.\n"
},
"addressLine2": {
"type": "string",
"description": "Second address line, 255 characters or less.\n"
},
"cardHolderName": {
"type": "string",
"description": "The card holder's full name as it appears on the card, e.g., \"John J Smith\", 50 characters or less.\n"
}
},
"description": "Container for cardholder information.\n"
},
"expirationYear": {
"type": "string",
"description": "Four-digit expiration year.\n"
},
"expirationMonth": {
"type": "string",
"description": "Two-digit expiration month (01-12).\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentMethodObjectCustomFields"
}
],
"title": "creditCard",
"description": "**Note:** This field has been deprecated, and is currently available only for backward compatibility. Use the `paymentMethod` field instead to create a payment method associated with this account.\n\nContainer for information on a credit card to associate with this account. \nIf the `autoPay` field is set to `true`, you must provide one of the `paymentMethod`, `creditCard`, or `hpmCreditCardPaymentMethodId` field, but not multiple.\n"
}
POSTAccountTypeSoldToContact
{
"allOf": [
{
"type": "object",
"required": [
"firstName",
"lastName"
],
"properties": {
"fax": {
"type": "string",
"description": "Fax phone number, 40 characters or less.\n"
},
"city": {
"type": "string",
"description": "City, 40 characters or less.\n"
},
"state": {
"type": "string",
"description": "State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided.\n"
},
"county": {
"type": "string",
"description": "County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax.\n"
},
"country": {
"type": "string",
"description": "Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.\n"
},
"zipCode": {
"type": "string",
"description": "Zip code, 20 characters or less.\n"
},
"address1": {
"type": "string",
"description": "First address line, 255 characters or less.\n"
},
"address2": {
"type": "string",
"description": "Second address line, 255 characters or less.\n"
},
"lastName": {
"type": "string",
"description": "Last name, 100 characters or less.\n"
},
"nickname": {
"type": "string",
"description": "Nickname for this contact\n"
},
"firstName": {
"type": "string",
"description": "First name, 100 characters or less.\n"
},
"homePhone": {
"type": "string",
"description": "Home phone number, 40 characters or less.\n"
},
"taxRegion": {
"type": "string",
"description": "If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n"
},
"workEmail": {
"type": "string",
"description": "Work email address, 80 characters or less.\n"
},
"workPhone": {
"type": "string",
"description": "Work phone number, 40 characters or less.\n"
},
"otherPhone": {
"type": "string",
"description": "Other phone number, 40 characters or less.\n"
},
"mobilePhone": {
"type": "string",
"description": "Mobile phone number, 40 characters or less.\n"
},
"personalEmail": {
"type": "string",
"description": "Personal email address, 80 characters or less.\n"
},
"otherPhoneType": {
"type": "string",
"description": "Possible values are: `Work`, `Mobile`, `Home`, `Other`.\n"
}
}
},
{
"$ref": "#/components/schemas/ContactObjectCustomFields"
}
],
"title": "soldToContact",
"description": "Container for optional sold-to contact; uses the same field structure as the bill-to contact (above). If a sold-to contact is not specified, one is created from the bill-to contact. Once created, these are two separate data entities, and future changes to one do not affect the other.\n"
}
POSTAccountTypeSubscription
{
"allOf": [
{
"type": "object",
"required": [
"contractEffectiveDate",
"termType"
],
"properties": {
"notes": {
"type": "string",
"description": ""
},
"termType": {
"type": "string",
"description": "Possible values are: `TERMED`, `EVERGREEN`.\n"
},
"autoRenew": {
"type": "boolean",
"description": "If `true`, auto-renew is enabled. Default is `false`.\n"
},
"initialTerm": {
"type": "integer",
"format": "int64",
"description": "Duration of the initial subscription term in whole months. Default is 0. \n"
},
"renewalTerm": {
"type": "integer",
"format": "int64",
"description": "Duration of the renewal term in whole months. Default is 0.\n"
},
"termStartDate": {
"type": "string",
"format": "date",
"description": "The date on which the subscription term begins, as `yyyy-mm-dd`. If this is a renewal subscription, this date is different from the subscription start date.\n"
},
"invoiceSeparately": {
"type": "boolean",
"description": "Separates a single subscription from other subscriptions and invoices the charge independently. \n\nIf the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice.\nThe default value is `false`.\n\nPrerequisite: The default subscription setting `Enable Subscriptions to be Invoiced Separately` must be set to `Yes`.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "Subscription Number. The value can be up to 1000 characters.\n\nIf you do not specify a subscription number when creating a subscription for the new account, Zuora will generate a subscription number automatically.\n\nIf the account is created successfully, the subscription number is returned in the `subscriptionNumber` response field.\n"
},
"subscribeToRatePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTSrpCreateType"
},
"description": "Container for one or more rate plans for this subscription.\n"
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "Effective contract date for this subscription, as `yyyy-mm-dd`.\n"
},
"serviceActivationDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been activated and access has been provided to the customer, as `yyyy-mm-dd`.\n\nDefault value is dependent on the value of other fields. See Notes section for more details.\n"
},
"customerAcceptanceDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been accepted by the customer, as `yyyy-mm-dd`.\n\nDefault value is dependent on the value of other fields. See Notes section for more details.\n"
},
"invoiceOwnerAccountKey": {
"type": "string",
"description": "Invoice owner account number or ID.\n\n**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). \n"
}
}
},
{
"$ref": "#/components/schemas/SubscriptionObjectQTFields"
},
{
"$ref": "#/components/schemas/SubscriptionObjectNSFields"
},
{
"$ref": "#/components/schemas/SubscriptionObjectCustomFields"
}
],
"title": "subscription",
"description": "Container for subscription information, used if creating a subscription for the new account at the time of account creation.\n"
}
POSTAccountingCodeResponseType
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the newly created accounting code.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
}
}
}
POSTAccountingCodeType
{
"allOf": [
{
"type": "object",
"required": [
"name",
"type"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the accounting code.\n\nAccounting code name must be unique. Maximum of 100 characters.\n"
},
"type": {
"enum": [
"AccountsReceivable",
"On-Account Receivable",
"Cash",
"OtherAssets",
"CustomerCashOnAccount",
"DeferredRevenue",
"SalesTaxPayable",
"OtherLiabilities",
"SalesRevenue",
"SalesDiscounts",
"OtherRevenue",
"OtherEquity",
"BadDebt",
"OtherExpenses"
],
"type": "string",
"description": "If you want to create multiple accounting codes of the type `AccountsReceivable`, you need to have [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) enabled and contact [Zuora Global Support](http://support.zuora.com) to access the Multiple AR Accounting Codes feature. \n\nNote that `On-Account Receivable` is only available if you enable the Invoice Settlement feature. \n"
},
"notes": {
"type": "string",
"description": "Maximum of 2,000 characters.\n"
},
"glAccountName": {
"type": "string",
"description": "Name of the account in your general ledger.\n\nField only available if you have Zuora Finance enabled. Maximum of 255 characters.\n"
},
"glAccountNumber": {
"type": "string",
"description": "Account number in your general ledger.\n\nField only available if you have Zuora Finance enabled. Maximum of 255 characters.\n"
}
}
},
{
"$ref": "#/components/schemas/AccountingCodeObjectCustomFields"
}
],
"example": {
"name": "CASH",
"type": "Cash"
}
}
POSTAccountingPeriodResponseType
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the newly-created accounting period.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
}
}
}
POSTAccountingPeriodType
{
"allOf": [
{
"type": "object",
"required": [
"name",
"startDate",
"endDate",
"fiscalYear"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the accounting period.\n\nAccounting period name must be unique. Maximum of 100 characters.\n"
},
"notes": {
"type": "string",
"description": "Notes about the accounting period.\n\nMaximum of 255 characters.\n"
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date of the accounting period in yyyy-mm-dd format, for example, \"2016-02-19\".\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the accounting period in yyyy-mm-dd format, for example, \"2016-02-19\".\n"
},
"fiscalYear": {
"type": "string",
"description": "Fiscal year of the accounting period in yyyy format, for example, \"2016\".\n"
},
"fiscal_quarter": {
"type": "integer",
"format": "int64",
"description": ""
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organization that the accounting period belongs to. \n\nFor each item in the array, either the `organizationId` or the `organizationName` field is required.\n\nThis field is only required when you have already turned on Multi-Org feature.\n"
}
}
},
{
"$ref": "#/components/schemas/AccountingPeriodObjectCustomFields"
}
],
"example": {
"name": "Jun 2016",
"notes": "optional notes here",
"endDate": "2016-06-30",
"startDate": "2016-06-01",
"fiscalYear": 2016
}
}
POSTAddItemsToPaymentScheduleRequest
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentScheduleItemCommon"
},
"title": "paymentScheduleItem"
}
},
"description": "Container for the payment schedule items to be added to the payment schedule.\n"
}
POSTAdjustmentResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"amount": {
"type": "string",
"format": "number",
"description": "The amount of the delivery adjustment.\n"
},
"reason": {
"type": "string",
"description": "The reason for the delivery adjustment.\n"
},
"status": {
"type": "string",
"description": "The status of the delivery adjustment will be `Billed` or `Cancelled`.\n"
},
"eligible": {
"type": "boolean",
"description": "The eligible flag is set as true for a successfully created delivery adjustment.\n"
},
"billingDate": {
"type": "string",
"format": "date",
"description": "The billing date is same as the delivery date of the delivery adjustment, in `yyyy-mm-dd` format.\n"
},
"deliveryDay": {
"type": "string",
"format": "string",
"description": "The delivery adjustment day of the week.\n"
},
"adjustmentId": {
"type": "string",
"format": "UUID",
"description": "The system generated delivery adjustment ID.\n"
},
"chargeNumber": {
"type": "string",
"description": "The charge number in the subscription for which the delivery adjustment is created.\n"
},
"deliveryDate": {
"type": "string",
"format": "date",
"description": "The delivery adjustment date, in `yyyy-mm-dd` format.\n"
},
"adjustmentNumber": {
"type": "string",
"format": "string",
"description": "The system generated delivery adjustment number.\n"
},
"creditMemoNumber": {
"type": "string",
"description": "The Credit Memo generated for the delivery adjustment.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "The subscription number for which the delivery adjustment is created.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n\n**Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n\n**Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n\n**Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.\n"
}
}
}
]
}
POSTAttachmentResponseType
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Attachment id.\n"
},
"fileId": {
"type": "string",
"description": "ID to identify the attached file. Use this file ID with [Get files](https://developer.zuora.com/api-references/api/operation/GET_Files) to download the file.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
}
}
}
POSTAuthorizeResponse
{
"type": "object",
"example": {
"success": true,
"resultCode": 0,
"resultMessage": "Request ID: 5231719060426316203012",
"transactionId": "5231719060426316203012",
"gatewayOrderId": "A001"
},
"properties": {
"reasons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error code.\n"
},
"message": {
"type": "string",
"description": "Error message. It usually contains a combination of gateway response code and response message.\n"
}
}
},
"description": "The container of the error code and message. This field is available only if the `success` field is `false`.\n"
},
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded."
},
"processId": {
"type": "string",
"description": "The ID of the running process when the exception occurs. This field is available only if the `success` field is `false`.\n"
},
"requestId": {
"type": "string",
"description": "The ID of the request. This field is available only if the `success` field is `false`\n"
},
"resultCode": {
"type": "string",
"description": "The result code of the request. \n\n0 indicates that the request succeeded, and the following values indicate that the request failed:\n - 1: The request is declined.\n - 7: The field format is not correct.\n - 10: Client connection has timed out.\n - 11: Host connection has timed out.\n - 12: Processor connection has timed out.\n - 13: Gateway server is busy.\n - 20: The card type is not supported.\n - 21: The merchant account information is invalid.\n - 22: A generic error occurred on the processor.\n - 40: The card type has not been set up yet.\n - 41: The limit for a single transaction is exceeded.\n - 42: Address checking failed.\n - 43: Card security code checking failed.\n - 44: Failed due to the gateway security setting.\n - 45: Fraud protection is declined.\n - 46: Address checking or card security code checking failed (for Authorize.net gateway only).\n - 47: The maximum amount is exceeded (for Authorize.net gateway only).\n - 48: The IP address is blocked by the gateway (for Authorize.net gateway only).\n - 49: Card security code checking failed (for Authorize.net gateway only).\n - 60: User authentication failed.\n - 61: The currency code is invalid.\n - 62: The transaction ID is invalid.\n - 63: The credit card number is invalid.\n - 64: The card expiration date is invalid.\n - 65: The transaction is duplicated.\n - 66: Credit transaction error.\n - 67: Void transaction error.\n - 90: A valid amount is required.\n - 91: The BA code is invalid.\n - 92: The account number is invalid.\n - 93: The ACH transaction is not accepted by the merchant.\n - 94: An error occurred for the ACH transaction.\n - 95: The version parameter is invalid.\n - 96: The transaction type is invalid.\n - 97: The transaction method is invalid.\n - 98: The bank account type is invalid.\n - 99: The authorization code is invalid.\n - 200: General transaction error.\n - 500: The transaction is queued for submission.\n - 999: Unknown error.\n - -1: An error occurred in gateway communication.\n - -2: Idempotency is not supported.\n - -3: Inquiry call is not supported.\n"
},
"resultMessage": {
"type": "string",
"description": "The corresponding request ID."
},
"transactionId": {
"type": "string",
"description": "The ID of the transaction."
},
"gatewayOrderId": {
"type": "string",
"description": "The order ID for the specific gateway.\n\nThe specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field.\n"
},
"paymentGatewayResponse": {
"type": "object",
"properties": {
"gatewayType": {
"type": "string",
"description": "The gateway type.\n"
},
"additionalInfo": {
"type": "object",
"description": "The additional information returned from the gateway. The returned fields vary for gateways. Here is an example.\n\n```\n\"additionalInfo\": {\n \"ProcessorName\": \"MasterCard Saferpay Test\",\n \"ProcessorResult\": \"51\",\n \"ProcessorMessage\": \"Insufficient funds\",\n \"ErrorName\": \"TRANSACTION_DECLINED\"\n}\n```\n"
},
"gatewayVersion": {
"type": "string",
"description": "The gateway version.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The HTTP response code.\n"
},
"gatewayResponseMessage": {
"type": "string",
"description": "The error message returned from the gateway.\n"
}
},
"description": "The response data returned from the gateway. This field is available only if the `success` field is `false` and the support for returning additional error information from the gateway is enabled.\n"
}
}
}
POSTBillingDocumentFilesDeletionJobRequest
{
"type": "object",
"example": {
"accountIds": [
"4028905558b483220158b48983dd0015",
"6028905558b483220158b68983dd0016"
],
"accountKeys": [
"4028905558b483220158b48983dd0015",
"A00000001"
]
},
"properties": {
"accountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Container for the IDs of the accounts that you want to create the billing document files deletion job for.\n\n**Note**: When creating jobs to delete billing document PDF files, you must specify either set of `accountIds` or `accountKeys` in the request body.\n"
},
"accountKeys": {
"type": "array",
"items": {
"type": "string"
},
"description": "Container for the IDs and/or numbers of the accounts that you want to create the billing document files deletion job for.\n\n**Note**: When creating jobs to delete billing document PDF files, you must specify either set of `accountIds` or `accountKeys` in the request body.\n"
}
}
}
POSTBillingDocumentFilesDeletionJobResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the billing document file deletion job.\n"
},
"status": {
"enum": [
"Pending"
],
"type": "string",
"description": "The status of the billing document file deletion job.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
}
}
}
POSTBillingPreviewCreditMemoItem
{
"type": "object",
"title": "creditMemoItems",
"properties": {
"id": {
"type": "string",
"description": "Credit memo item id.\n"
},
"sku": {
"type": "string",
"description": "Unique SKU for the product associated with this item.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax\n"
},
"comment": {
"type": "string",
"description": "Comment of the credit memo item.\n"
},
"skuName": {
"type": "string",
"description": "Name of the unique SKU for the product associated with this item.\n"
},
"quantity": {
"type": "string",
"format": "decimal",
"description": "Quantity of this item, in the configured unit of measure for the charge.\n"
},
"chargeDate": {
"type": "string",
"format": "date-time",
"description": "The date when the credit memo item is created.\n"
},
"chargeType": {
"type": "string",
"description": "The type of charge. \n\nPossible values are `OneTime`, `Recurring`, and `Usage`.\n"
},
"chargeNumber": {
"type": "string",
"description": "Number of the charge.\n"
},
"unitOfMeasure": {
"type": "string",
"description": "Unit used to measure consumption.\n"
},
"processingType": {
"type": "string",
"description": "Identifies the kind of charge. \n\nPossible values:\n* charge\n* discount\n* prepayment\n* tax\n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "End date of the service period for this item, i.e., the last day of the service period, in yyyy-mm-dd format.\n"
},
"subscriptionId": {
"type": "string",
"description": "ID of the subscription associated with this item.\n"
},
"appliedToItemId": {
"type": "string",
"description": "The unique ID of the credit memo item that the discount charge is applied to.\n"
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "The credit memo item amount excluding tax.\n"
},
"ratePlanChargeId": {
"type": "string",
"description": "Id of the rate plan charge associated with this item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "Start date of the service period for this item, in yyyy-mm-dd format. If the charge is a one-time fee, this is the date of that charge.\n"
},
"numberOfDeliveries": {
"type": "number",
"description": "The number of deliveries dedicated to the Delivery Pricing charges. \n**Note**: This field is available only if you have the Delivery Pricing feature enabled. \n"
},
"subscriptionNumber": {
"type": "string",
"description": "Name of the subscription associated with this item.\n"
}
}
}
POSTBillingPreviewInvoiceItem
{
"type": "object",
"title": "invoiceItems",
"properties": {
"id": {
"type": "string",
"description": "Invoice item ID.\n"
},
"chargeId": {
"type": "string",
"description": "Id of the charge.\n"
},
"quantity": {
"type": "string",
"format": "decimal",
"description": "Quantity of this item, in the configured unit of measure for the charge.\n"
},
"taxAmount": {
"type": "string",
"format": "decimal",
"description": "If you use [Zuora Tax](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax) and the product rate plan charge associated with the invoice item is of [tax inclusive mode](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax/D_Associate_tax_codes_with_product_charges_and_set_the_tax_mode), the value of this field is the amount of tax applied to the charge. Otherwise, the value of this field is `0`. \n"
},
"chargeDate": {
"type": "string",
"format": "date-time",
"description": "The date when the invoice item was created.\n"
},
"chargeName": {
"type": "string",
"description": "Name of the charge.\n"
},
"chargeType": {
"type": "string",
"description": "The type of charge. \n\nPossible values are `OneTime`, `Recurring`, and `Usage`.\n"
},
"productName": {
"type": "string",
"description": "Name of the product associated with this item.\n"
},
"chargeAmount": {
"type": "string",
"format": "decimal",
"description": "The amount of the charge. This amount doesn't include taxes regardless if the charge's tax mode is inclusive or exclusive.\n"
},
"chargeNumber": {
"type": "string",
"description": "Number of the charge.\n"
},
"unitOfMeasure": {
"type": "string",
"description": "Unit used to measure consumption.\n"
},
"processingType": {
"type": "string",
"description": "Identifies the kind of charge. \n\nPossible values:\n* charge\n* discount\n* prepayment\n* tax\n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "End date of the service period for this item, i.e., the last day of the service period, in `yyyy-mm-dd` format.\n"
},
"subscriptionId": {
"type": "string",
"description": "ID of the subscription associated with this item.\n"
},
"appliedToItemId": {
"type": "string",
"description": "The unique ID of the invoice item that the discount charge is applied to.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "Start date of the service period for this item, in `yyyy-mm-dd` format. If the charge is a one-time fee, this is the date of that charge.\n"
},
"subscriptionName": {
"type": "string",
"description": "Name of the subscription associated with this item.\n"
},
"chargeDescription": {
"type": "string",
"description": "Description of the charge.\n"
},
"numberOfDeliveries": {
"type": "number",
"description": "The number of deliveries dedicated to the Delivery Pricing charges. \n**Note**: This field is available only if you have the Delivery Pricing feature enabled. \n"
},
"subscriptionNumber": {
"type": "string",
"description": "Number of the subscription associated with this item.\n"
}
}
}
POSTBulkCreditMemosRequestType
{
"oneOf": [
{
"$ref": "#/components/schemas/BulkCreateCreditMemosFromInvoiceRequest"
},
{
"$ref": "#/components/schemas/BulkCreateCreditMemosFromChargeRequest"
}
],
"discriminator": {
"mapping": {
"Invoice": "#/components/schemas/BulkCreateCreditMemosFromInvoiceRequest",
"Standalone": "#/components/schemas/BulkCreateCreditMemosFromChargeRequest"
},
"propertyName": "sourceType"
}
}
POSTBulkDebitMemosRequestType
{
"oneOf": [
{
"$ref": "#/components/schemas/BulkCreateDebitMemosFromInvoiceRequest"
},
{
"$ref": "#/components/schemas/BulkCreateDebitMemosFromChargeRequest"
}
],
"discriminator": {
"mapping": {
"Invoice": "#/components/schemas/BulkCreateDebitMemosFromInvoiceRequest",
"Standalone": "#/components/schemas/BulkCreateDebitMemosFromChargeRequest"
},
"propertyName": "sourceType"
}
}
POSTBulkPdfGenerationJobRequestType
{
"allOf": [
{
"type": "object",
"example": {
"name": "BulkPDFGenerationJobV1",
"fileName": "all-invoices-posted-jan-2024",
"documents": [
{
"docType": "Invoice",
"objectIds": [
"402880de8ce7edc3018ce7f18404315a",
"402880de8ce7edc3018ce7f18e0b3804"
]
}
],
"indexFileFormat": "JSON",
"generateMissingPDF": true
},
"required": [
"documents",
"fileName",
"indexFileFormat"
],
"properties": {
"name": {
"type": "string",
"maxLength": 32,
"description": "The name of the job.\n"
},
"fileName": {
"type": "string",
"maxLength": 32,
"description": "The prefix part of output file name(s). The response will include multiple file URLs. The number of zip files generated corresponds to the number of invoice IDs. Each zip file contains up to 1000 document IDs.\nEg: \n if fileName is \"all-invoices-posted-jan-2024\" then fileURL(s) will start with the file name followed by an underscore and a number. For instance, all-invoices-posted-jan-2024_1.zip, all-invoices-posted-jan-2024_2.zip, and so on.\n"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentList"
},
"description": "An array that contains a collection of objects where each object contains billing document type and their IDs.\n"
},
"indexFileFormat": {
"enum": [
"JSON",
"CSV"
],
"type": "string",
"description": "The format of the index file. It contains the metadata about the files and their contents.\n"
},
"generateMissingPDF": {
"type": "boolean",
"description": "This flag controls the behavior of whether to generate PDF(s) for billing documents that do not already have one.\n\n - setting it to true indicates service would go through the provided document ID list, find the billing documents that do not have a generated PDF,\n generate them all at once, and then proceed to the zipping process.\n\n - setting it to false indicates service would go through the provided document ID list, find the billing documents that do not have a generated PDF,\n mark them as Invalid, and skip them from the zipping process. IDs marked as invalid will be included in the response.\n\nThe default value is false.\n"
}
}
}
]
}
POSTBulkPdfGenerationJobResponseType
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"description": "Unique Id for the Job Triggered.\n"
},
"invalidIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Collection of Ids that are not valid. \n\n Id is considered to be invalid if,\n \n * Billing Document Id doesn't exist in the database for the corresponding Billing Document Type\n * generateMissingPDF property is false in the Job Request and Valid PDF doesn't exist for the Billing Document Id\n"
}
}
}
],
"example": {
"jobId": "402880de8ce7edc3018ce7f18404312a",
"success": true,
"invalidIds": []
}
}
POSTCatalogGroupRequest
{
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The unique name of the catalog group.\n"
},
"type": {
"enum": [
"Grading",
"Display"
],
"type": "string",
"default": "Grading",
"description": "The type of the catalog group. \n"
},
"description": {
"type": "string",
"description": "The description of the catalog group.\n"
},
"productRatePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTorPUTCatalogGroupAddProductRatePlan"
},
"description": "The list of product rate plans to be added to the catalog group.\n"
}
}
}
],
"example": {
"name": "Example",
"type": "Grading",
"description": "description",
"productRatePlans": [
{
"id": "4028e5ab7f1b600c017f1b787d5d01cfX",
"grade": 3
},
{
"id": "4028e5ab7f1b600c017f1b787d5d01ac",
"grade": 2
}
]
}
}
POSTChargeDefinitionBulkResponse
{
"type": "object",
"properties": {
"productChargeDefinitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTChargeDefinitionResponse"
},
"description": "The list of created product charge definitions.\n"
}
}
}
POSTChargeDefinitionPricingTier
{
"type": "array",
"items": {
"type": "object",
"properties": {
"price": {
"type": "number",
"format": "double",
"description": "The price of the tier if the price format is flat fee, or the price of each unit in the tier if the price format is per unit.\n"
},
"currency": {
"type": "string",
"description": "The code corresponding to the currency for the tier's price.\n"
},
"endingUnit": {
"type": "number",
"format": "double",
"description": "The end number of a range of units for the tier. This field is required for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model.\n"
},
"priceFormat": {
"enum": [
"Flat Fee",
"Per Unit"
],
"type": "string",
"description": "The price format of the tier.\n"
},
"startingUnit": {
"type": "number",
"format": "double",
"description": "The starting number of a range of units for the tier. This field is required for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model.\n"
}
}
},
"title": "pricingTiers",
"description": "An array of charge pricing tier.\n"
}
POSTChargeDefinitionRequest
{
"type": "object",
"title": "productChargeDefinitions",
"example": {
"uom": "Each",
"term": 24,
"prices": [
{
"price": 10,
"currency": "USD"
}
],
"taxCode": "a valid tax code",
"taxMode": "TaxExclusive",
"taxable": false,
"termType": "TERMED",
"chargeModel": "FlatFee",
"billingPeriod": "Specific_Months",
"listPriceBase": "Per_Billing_Period",
"termPeriodType": "Month",
"defaultQuantity": 10,
"effectiveEndDate": "2025-01-01 00:00:00",
"productRatePlanId": "2c9890e489f227bd0189f22c3c730002",
"effectiveStartDate": "2024-01-01 00:00:00",
"productRatePlanNumber": "PRP-NEW-00000242",
"specificBillingPeriod": 10,
"specificListPriceBase": 101,
"productRatePlanChargeId": "2c9890e489f227bd0189f22f3482001f",
"productRatePlanChargeNumber": "PRPC-00000015"
},
"properties": {
"uom": {
"type": "string",
"nullable": true,
"description": "Describes the unit of measure (UOM) configured in **Settings > Billing** for the charge.\n"
},
"term": {
"type": "number",
"nullable": true,
"description": "The number of periods of a termed subscription that is eligible for this charge definition. This field is applicable when the `termType` field is set to `TERMED`, \nand is to be used together with the `termPeriodType` field.\n"
},
"prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTProductChargeDefinitionPricing"
},
"description": "Container for the prices of the product charge definition.\n"
},
"taxCode": {
"type": "string",
"maxLength": 64,
"description": "Specifies the tax code for taxation rules. This field is required when the `Taxable` field is set to `True`.\n\n**Note**: This value affects the tax calculation of the charge.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive",
null
],
"type": "string",
"nullable": true,
"description": "Determines how to define taxation for the charge. This field is required when the `Taxable` field is set to `True`.\n\n**Note**: This value affects the tax calculation of the charge.\n"
},
"taxable": {
"type": "boolean",
"description": "Determines whether the charge definition is taxable. When this field is set to `True`, the `TaxMode` and `TaxCode` fields are required.\n\n**Character limit**: 5\n\n**Values**: `True`, `False`\n\n**Note**: This value affects the tax calculation of the charge.\n"
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN",
null
],
"type": "string",
"nullable": true,
"description": "The type of the subscription that is eligible for this charge definition.\n"
},
"chargeModel": {
"enum": [
"DiscountFixedAmount",
"DiscountPercentage",
"FlatFee",
"PerUnit",
"Tiered",
"Volume",
"Delivery"
],
"type": "string",
"description": "Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n"
},
"billingPeriod": {
"type": "string",
"description": "The billing period for the product charge definition.\n"
},
"billingTiming": {
"enum": [
"IN_ADVANCE",
"IN_ARREARS"
],
"type": "string",
"description": "The billing timing setting for the product charge definition.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year"
],
"type": "string",
"description": "The list price base. \n\nThis field is applicable only for recurring charges.\n\n**Note**: The `Per_Year` enum value is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n"
},
"termPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week",
null
],
"type": "string",
"nullable": true,
"description": "Specifies the period type for the subscription term that is eligible for this charge definition.\n"
},
"defaultQuantity": {
"type": "number",
"nullable": true,
"description": "The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n"
},
"effectiveEndDate": {
"type": "string",
"format": "date-time",
"description": "The effective end date of the product charge definition.\n"
},
"productRatePlanId": {
"type": "string",
"description": "The unique ID of the product rate plan that uses this charge definition.\n"
},
"effectiveStartDate": {
"type": "string",
"format": "date-time",
"description": "The effective start date of the product charge definition.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "The unique number (natural key) of the product rate plan that uses this charge definition.\n"
},
"specificBillingPeriod": {
"type": "number",
"nullable": true,
"description": "The specific number of billing periods for the product charge definition.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"nullable": true,
"description": "The number of months for the list price base of the charge definition. \nThis field is `null` if the `listPriceBase` field is not set to `Per_Specific_Months`.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The unique ID of the charge of the charge definition.\n"
},
"productRatePlanChargeNumber": {
"type": "string",
"description": "The unique number (natural key) of the charge of the charge definition.\n"
}
}
}
POSTChargeDefinitionRequestBulk
{
"type": "object",
"example": {
"productChargeDefinitions": [
{
"uom": "Each",
"term": 24,
"prices": [
{
"price": 10,
"currency": "USD"
}
],
"taxCode": "a valid tax code",
"taxMode": "TaxExclusive",
"taxable": false,
"termType": "TERMED",
"chargeModel": "FlatFee",
"billingPeriod": "Specific_Months",
"listPriceBase": "Per_Billing_Period",
"termPeriodType": "Month",
"defaultQuantity": 10,
"effectiveEndDate": "2025-01-01 00:00:00",
"productRatePlanId": "2c9890e489f227bd0189f22c3c730002",
"effectiveStartDate": "2024-01-01 00:00:00",
"productRatePlanNumber": "PRP-NEW-00000242",
"specificBillingPeriod": 10,
"specificListPriceBase": 101,
"productRatePlanChargeId": "2c9890e489f227bd0189f22f3482001f",
"productRatePlanChargeNumber": "PRPC-00000015"
}
]
},
"properties": {
"productChargeDefinitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTChargeDefinitionRequest"
},
"description": "Container for the array of product charge definition.\n"
}
}
}
POSTChargeDefinitionResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Indicates whether the request succeeded.\n"
},
"chargeDefinitionId": {
"type": "string",
"description": "The unique ID of the product charge definition.\n"
},
"chargeDefinitionNumber": {
"type": "string",
"description": "The unique number (natural key) of the product charge definition.\n"
}
}
}
POSTContactType
{
"allOf": [
{
"type": "object",
"required": [
"firstName",
"lastName"
],
"properties": {
"fax": {
"type": "string",
"maxLength": 40,
"description": "The contact's fax number.\n"
},
"city": {
"type": "string",
"maxLength": 40,
"description": "The city of the contact's address.\n"
},
"state": {
"type": "string",
"maxLength": 40,
"description": "The state or province of the contact's address.\n"
},
"county": {
"type": "string",
"maxLength": 32,
"description": "The county. May optionally be used by Zuora Tax to calculate county tax.\n"
},
"country": {
"type": "string",
"maxLength": 64,
"description": "The country of the contact's address.\n"
},
"zipCode": {
"type": "string",
"maxLength": 20,
"description": "The zip code for the contact's address.\n"
},
"address1": {
"type": "string",
"maxLength": 255,
"description": "The first line of the contact's address, which is often a street address or business name.\n"
},
"address2": {
"type": "string",
"maxLength": 255,
"description": "The second line of the contact's address.\n"
},
"lastName": {
"type": "string",
"maxLength": 100,
"description": "The contact's last name.\n"
},
"nickname": {
"type": "string",
"maxLength": 100,
"description": "A nickname for the contact.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with the contact. \n\n**Note**: When creating a contact, you must specify `accountNumber`, `accountId`, or both in the request body. If both fields are specified, they must correspond to the same account.\n"
},
"firstName": {
"type": "string",
"maxLength": 100,
"description": "The contact's first name.\n"
},
"homePhone": {
"type": "string",
"maxLength": 40,
"description": "The contact's home phone number.\n"
},
"taxRegion": {
"type": "string",
"maxLength": 32,
"description": "If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n"
},
"workEmail": {
"type": "string",
"maxLength": 74,
"description": "The contact's business email address.\n"
},
"workPhone": {
"type": "string",
"maxLength": 40,
"description": "The contact's business phone number.\n"
},
"otherPhone": {
"type": "string",
"maxLength": 40,
"description": "An additional phone number for the contact.\n"
},
"mobilePhone": {
"type": "string",
"maxLength": 100,
"description": "The mobile phone number of the contact.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account associated with the contact. \n\n**Note**: When creating a contact, you must specify `accountNumber`, `accountId`, or both in the request body. If both fields are specified, they must correspond to the same account.\n"
},
"personalEmail": {
"type": "string",
"maxLength": 74,
"description": "The contact's personal email address.\n"
},
"otherPhoneType": {
"enum": [
"Work",
"Mobile",
"Home",
"Other"
],
"type": "string",
"description": "The type of the additional phone number.\n"
},
"contactDescription": {
"type": "string",
"maxLength": 100,
"description": "A description for the contact.\n"
}
}
},
{
"$ref": "#/components/schemas/ContactObjectCustomFields"
}
],
"example": {
"fax": "6174",
"city": "GHY",
"state": "Assam",
"country": "India",
"zipCode": "123456",
"address1": "314, Bongora",
"address2": "near Tech City",
"lastName": "Das",
"nickname": "Dorimi",
"accountId": "6e767220676e6e61206776652075207570",
"firstName": "Kuhi",
"homePhone": "1234123",
"otherPhone": "2314213",
"mobilePhone": "123213",
"accountNumber": "A00000001",
"personalEmail": "kuhiroll@example.com",
"otherPhoneType": "Work",
"contactDescription": "This is a description for the contact"
}
}
POSTCreateBillRunRequestType
{
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the bill run.\n"
},
"batches": {
"type": "array",
"items": {
"type": "string"
},
"description": "The batch of accounts for this bill run. \n\nYou can only specify either this field or the `billRunFilters` field.\n\n**Values:** `AllBatches` or an array of `Batch*n*` where *n* is one of numbers 1 - 50, for example, `Batch7`.\n\n**Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite\" target=\"_blank\">Performance Booster Elite</a> package.\n"
},
"autoPost": {
"type": "boolean",
"default": false,
"description": "Whether to automatically post the bill run after the bill run is created.\n\n**Note:** To use this field, you must first set the <a href=\"https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Billing_Rules\" target=\"_blank\">Support Bill Run Auto-Post?</a> billing rule to **Yes** through the Zuora UI.\n"
},
"schedule": {
"$ref": "#/components/schemas/BillRunScheduleRequestType"
},
"autoEmail": {
"type": "boolean",
"default": false,
"description": "Whether to automatically send emails after Auto-Post is complete.\n\n**Note:** To use this field, you must first set the <a href=\"https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Billing_Rules\" target=\"_blank\">Support Bill Run Auto-Post?</a> billing rule to **Yes** through the Zuora UI.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for this bill run. \n\n- You must specify this field when creating an ad-hoc bill run.\n- For scheduled bill runs, if you do not specify any value for this field, the target date is the value of the `repeatFrom` field.\n"
},
"autoRenewal": {
"type": "boolean",
"default": false,
"description": "Whether to automatically renew auto-renew subscriptions that are up for renewal.\n"
},
"billRunType": {
"type": "string",
"description": "The type of the bill run. If you do not specify any value for this field, the default value is `Regular`.\n\n- You can use this field only if the \"Catch-Up Bill Run\" feature is enabled. \n- You must specify this field to create a catch up bill run.\n\n**Values:** \n- `Regular`\n- `CatchUp`\n"
},
"invoiceDate": {
"type": "string",
"format": "date",
"description": "The invoice date for the bill run.\n\n- When creating an ad-hoc bill run, if you do not specify any value for this field, the default value is the current date.\n- When creating a scheduled bill run, if you do not specify any value for this field, the invoice date is the value of the `repeatFrom` field. \n"
},
"billCycleDay": {
"type": "string",
"description": "The day of the bill cycle. This field is only valid if the `batches` field is specified.\n\n**Values:** \n- `AllBillCycleDays` or one of numbers 1 - 31 for an ad-hoc bill run\n- `AllBillCycleDays`, one of numbers 1 - 31, or `AsRunDay` for a scheduled bill run\n"
},
"billRunFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillRunFilterRequestType"
},
"description": "The target account or subscriptions for this bill run. You can only specify either this field or the `batches` field.\n"
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organization(s) that the bill run is created for. \n\nFor each item in the array, either the `organizationId` or the `organizationName` field is required.\n\nThis field is only required when you have already turned on Multi-Org feature.\n"
},
"chargeTypeToExclude": {
"type": "array",
"items": {
"enum": [
"OneTime",
"Recurring",
"Usage"
],
"type": "string"
},
"description": "The types of the charges to be excluded from the generation of billing documents. You can specify at most two charge types in the array.\n"
},
"noEmailForZeroAmountInvoice": {
"type": "boolean",
"default": false,
"description": "Whether to suppress emails for invoices with zero total amount generated in this bill run after the bill run is complete. \n\nIt is best practice to not send emails for invoices with zero amount.\n"
}
}
}
],
"example": {
"name": "test",
"autoPost": false,
"autoEmail": false,
"targetDate": "2020-02-01",
"autoRenewal": false,
"invoiceDate": "2020-02-01",
"billRunFilters": [
{
"accountId": "2c9081a03c63c94c013c66688a2c00bf",
"filterType": "Subscription",
"subscriptionId": "402882297e387c51017e38a245c313db"
}
],
"chargeTypeToExclude": [
"OneTime",
"Usage"
],
"noEmailForZeroAmountInvoice": false
}
}
POSTCreateBillingAdjustmentRequestType
{
"type": "object",
"example": {
"type": "DeliveryCredit",
"reason": "string",
"endDate": "2023-02-27",
"exclusion": [
{
"deliveryDate": "2023-02-26",
"chargeNumbers": [
"string",
"string"
]
},
{
"deliveryDate": "2023-05-27",
"chargeNumbers": [
"string",
"string"
]
}
],
"startDate": "2023-02-26",
"chargeNumbers": [
"string",
"string"
],
"subscriptionNumber": "string",
"revenueRecognitionRuleName": "string",
"deferredRevenueAccountingCode": "string",
"recognizedRevenueAccountingCode": "string"
},
"required": [
"startDate",
"endDate"
],
"properties": {
"type": {
"enum": [
"DeliveryCredit"
],
"type": "string",
"description": "The type of delivery adjustment.\n"
},
"reason": {
"type": "string",
"description": "The reason for the delivery adjustment.\n"
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive.\n"
},
"exclusion": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deliveryDate": {
"type": "string",
"format": "date",
"description": "The date on which the delivery adjustment has to be excluded, in `yyyy-mm-dd` format.\n"
},
"chargeNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "The charge numbers to be excluded from delivery adjustment on the specified delivery date.\n"
}
}
},
"description": "The charge numbers and the corresponding dates for exclusion of delivery adjustment.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive.\n"
},
"accountNumber": {
"type": "string",
"description": "The account number for which the delivery adjustment is created. \n\n**Note**: \n - The account number should be of the subscription owner.\n - Only one of accountNumber or subscriptionNumber should be provided.\n"
},
"chargeNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "An optional container to specify charge numbers in the subscription for which the delivery adjustment needs to be created.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "The subscription number for which the delivery adjustment is created.\n\n**Note**: Only one of accountNumber or subscriptionNumber should be provided.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n\n\n**Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n\n**Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n\n**Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.\n"
}
}
}
POSTCreateInvoiceScheduleRequest
{
"allOf": [
{
"type": "object",
"properties": {
"notes": {
"type": "string",
"maxLength": 255,
"description": "Comments on the invoice schedule.\n"
},
"orders": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of the IDs or numbers of the orders associated with the invoice schedule. One invoice schedule can be associated with at most 10 orders.\n"
},
"accountKey": {
"type": "string",
"description": "The ID or number of the account associated with the invoice schedule.\n"
},
"scheduleItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTScheduleItemType"
},
"description": "Container for invoice schedule items. One invoice schedule can have at most 50 invoice schedule items.\n"
},
"invoiceSeparately": {
"type": "boolean",
"description": "Whether the invoice items created from the invoice schedule appears on a separate invoice when Zuora generates invoices.\n"
},
"specificSubscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceScheduleSpecificSubscriptions"
},
"description": "A list of the numbers of specific subscriptions associated with the invoice schedule.\n\n- If the subscriptions specified in this field belong to the orders specified in the `orders` field, only the specific subscriptions instead of the orders are associated with the invoice schedule. \n- If only the `orders` field is specified, all the subscriptions from the order are associated with the invoice schedule.\n\nExample:\n```\n{\n \"orders\": [\n \"O-00000001\", \"O-00000002\"\n ],\n \"specificSubscriptions\": [\n {\n \"orderKey\": \"O-00000001\",\n \"subscriptionKey\": \"S-00000001\"\n }\n ]\n}\n```\n- For the order with number O-00000001, only subscription S-00000001 contained in the order is associated with the invoice schedule.\n- For the order with number O-00000002, all subscriptions contained in the order are associated with the invoice schedule.\n"
},
"additionalSubscriptionsToBill": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of the numbers of the subscriptions that need to be billed together with the invoice schedule. \n\nOne invoice schedule can have at most 600 additional subscriptions.\n"
}
}
},
{
"$ref": "#/components/schemas/InvoiceScheduleCustomFields"
},
{}
],
"example": {
"notes": "2022 Billing Schedule",
"orders": [
"O-00000007",
"O-00000008"
],
"accountKey": "A00000007",
"scheduleItems": [
{
"amount": 50000,
"runDate": "2022-02-24",
"targetDateForAdditionalSubscriptions": "2022-02-24"
},
{
"amount": 14000,
"runDate": "2022-10-17",
"targetDateForAdditionalSubscriptions": "2022-10-17"
},
{
"amount": 6200,
"runDate": "2022-11-14",
"targetDateForAdditionalSubscriptions": "2022-11-14"
}
],
"invoiceSeparately": false,
"specificSubscriptions": [
{
"orderKey": "O-00000008",
"subscriptionKey": "S-00000008"
}
],
"additionalSubscriptionsToBill": [
"S-00000001",
"S-00000002"
]
}
}
POSTCreateOpenPaymentMethodTypeRequest
{
"example": {
"label": "ZuoraQA Amazon Pay",
"fields": [
{
"name": "AmazonToken",
"type": "string",
"index": 1,
"label": "AmazonToken",
"visible": true,
"checksum": true,
"editable": true,
"required": true,
"maxLength": 100,
"minLength": 1,
"description": "The Token value",
"representer": true,
"defaultValue": null
},
{
"name": "AmazonTokenType",
"type": "string",
"index": 2,
"label": "Amazon TokenType",
"visible": true,
"checksum": true,
"editable": true,
"required": true,
"maxLength": 100,
"minLength": 1,
"description": "The Type of Token, e.g. GoCardlessToken",
"representer": true,
"defaultValue": null
}
],
"entityId": "",
"tenantId": "9",
"internalName": "AmazonPay",
"subTypeField": "AmazonTokenType",
"userReferenceIdField": "",
"methodReferenceIdField": "AmazonToken"
},
"required": [
"internalName",
"tenantId",
"label",
"methodReferenceIdField",
"fields"
],
"properties": {
"label": {
"type": "string",
"maxLength": 40,
"description": "The label that is used to refer to this type in the Zuora UI.\n\nThis value must be alphanumeric, excluding JSON preserved characters such as * \\ ’ ” \n"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OpenPaymentMethodTypeRequestFields"
},
"description": "An array containing field metadata of the custom payment method type.\n\nNotes:\n - All the following nested metadata must be provided in the request to define a field. \n - At least one field must be defined in the fields array for a custom payment method type. \n - Up to 20 fields can be defined in the fields array for a custom payment method type.\n"
},
"entityId": {
"type": "string",
"description": "If this custom payment method type is specific to one entity only, provide the entity ID in this field in UUID format, such as `123e4567-e89b-12d3-a456-426614174000`. If no entity UUID is provided, the custom payment method type is available to the global entity and all the sub entities in the tenant.\n\nYou can get the entity ID through the [Multi-entity: List entities](https://developer.zuora.com/api-references/older-api/operation/GET_Entities/) API operation or the **Manage Entity Profile** administration setting in the UI. To convert the format of the entity ID to UUID, separate the entity ID string in five groups with hyphens, in the form `<8-characters>-<4-characters>-<4-characters>-<4-characters>-<12-characters>` for a total of 36 characters.\n\nNote: After the custom payment method type is created, you can only update this field to be empty.\n"
},
"tenantId": {
"type": "string",
"description": "Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities.\n\nThis field cannot be updated after the creation of the custom payment method type.\n"
},
"internalName": {
"type": "string",
"maxLength": 19,
"description": "A string to identify the custom payment method type in the API name of the payment method type.\n\nThis field must be alphanumeric, starting with a capital letter, excluding JSON preserved characters such as * \\ ’ ”. Additionally, '_' or '-' is not allowed.\n\nThis field must be unique in a tenant.\n\nThis field is used along with the `tenantId` field by the system to construct and generate the API name of the custom payment method type in the following way:\n\n`<internalName>__c_<tenantId>`\n\nFor example, if `internalName` is `AmazonPay`, and `tenantId` is `12368`, the API name of the custom payment method type will be `AmazonPay__c_12368`.\n\nThis field cannot be updated after the creation of the custom payment method type.\n"
},
"subTypeField": {
"type": "string",
"description": "The identification reference indicating the subtype of the custom payment method.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.\n\nThis field cannot be updated after the creation of the custom payment method type.\n"
},
"userReferenceIdField": {
"type": "string",
"description": "The identification reference of the user or customer account.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.\n\nThis field cannot be updated after the creation of the custom payment method type.\n"
},
"methodReferenceIdField": {
"type": "string",
"description": "The identification reference of the custom payment method.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query.\n\nThis field cannot be updated after the creation of the custom payment method type.\n"
}
}
}
POSTCreateOpenPaymentMethodTypeResponse
{
"properties": {
"status": {
"type": "string",
"description": "The status of the custom payment method type.\n"
},
"revision": {
"type": "integer",
"description": "The revision number of the custom payment method type, which starts from 1 and increases by 1 when you update a published revision for the first time.\n"
},
"publishDate": {
"type": "string",
"description": "The date when the custom payment method type was published. It is empty if the custom payment method type has not been published yet.\n"
},
"paymentMethodType": {
"type": "string",
"description": "The API name of the custom payment method type.\n"
}
}
}
POSTCreateOrUpdateEmailTemplateRequest
{
"type": "object",
"example": {
"emailTemplates": [
{
"id": "8500105b9a1045019474652bd81c7ce5",
"name": "Account Edit Email",
"active": true,
"isHtml": true,
"fromName": "Example Co. Ltd.",
"emailBody": "Dear user,<p>the account <Account.Name> has been edited. </p><p>Example Co. Ltd.</p>",
"ccEmailType": "SpecificEmails",
"description": "Email when an account is edited",
"toEmailType": "SpecificEmails",
"emailHeaders": {
"My-Header-1": "Header value 1",
"My-Header-2": "Header value 2"
},
"emailSubject": "Account <Account.Number> has been edited",
"encodingType": "UTF8",
"eventTypeName": "AccountEdit",
"fromEmailType": "TenantEmail",
"ccEmailAddress": "user@example.com",
"toEmailAddress": "DummyEmailAddress@example.com",
"bccEmailAddress": "user@example.com",
"replyToEmailType": "TenantEmail"
},
{
"name": "Credit Memo Refund Processed Default Email Template",
"active": true,
"isHtml": true,
"fromName": "Admin",
"emailBody": "Dear <BillToContact.FirstName> <BillToContact.LastName>,\r\n\r\nA refund of <Refund.Amount> <Account.Currency> was processed against your credit memo on <Refund.Date>.\r\n\r\nYour new account unapplied credit memo amount is <Account.UnappliedCreditMemoAmount> <Account.Currency> and your account balance is <Account.Balance> <Account.Currency>.\r\n\r\nThank you for your business!",
"ccEmailType": "SpecificEmails",
"description": "Updated Description",
"toEmailType": "BillToContact",
"emailHeaders": {
"My-Header-1": "Header value 1",
"My-Header-2": "Header value 2"
},
"emailSubject": "Your credit memo refund was successfully processed",
"encodingType": "UTF8",
"eventCategory": 2830,
"fromEmailType": "SpecificEmail",
"ccEmailAddress": "user@example.com",
"toEmailAddress": "",
"bccEmailAddress": "",
"fromEmailAddress": "support@zuora.com",
"replyToEmailType": "SpecificEmail",
"replyToEmailAddress": "support@zuora.com"
}
],
"allowPartialSuccess": true
},
"properties": {
"emailTemplates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTCreateOrUpdateEmailTemplateRequestFormat"
},
"description": "A container for email templates.\n"
},
"allowPartialSuccess": {
"type": "boolean",
"description": "When set to `false`, the call will fail if one or multiple instances fail to import, and a `200` response is returned if all email templates have been successfully updated.\nWhen set to `true`, a success (`200`) response is returned if one or more instances have imported successfully. All failed instances are also returned in the response.\n"
}
}
}
POSTCreateOrUpdateEmailTemplateRequestFormat
{
"type": "object",
"required": [
"name",
"fromEmailType",
"emailSubject",
"emailBody",
"toEmailType"
],
"properties": {
"id": {
"type": "string",
"description": "ID of an existing email template. Specify this field if you want to update an existing email template.\n"
},
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the email template, a unique name in a tenant."
},
"active": {
"type": "boolean",
"default": true,
"description": "The status of the email template. The default value is `true`."
},
"isHtml": {
"type": "boolean",
"default": false,
"description": "Indicates whether the style of email body is HTML. The default value is `false`."
},
"fromName": {
"type": "string",
"description": "The name of the email sender."
},
"emailBody": {
"type": "string",
"description": "The email body. You can add merge fields in the email body using angle brackets or double curly brackets. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates\" target=\"_blank\">Merge field syntax for email templates</a>. \n\nYou can also embed HTML tags if `isHtml` is `true`.\n"
},
"ccEmailType": {
"enum": [
"BillToContact",
"SoldToContact",
"SpecificEmails",
"TenantAdmin",
"BillToAndSoldToContacts",
"RunOwner",
"AllContacts",
"InvoiceOwnerBillToContact",
"InvoiceOwnerSoldToContact",
"InvoiceOwnerBillToAndSoldToContacts",
"InvoiceOwnerAllContacts"
],
"type": "string",
"default": "SpecificEmails",
"description": "Email CC type.\n* When the base object for the event is associated with `Account`, `ccEmailType` can be any values in the enum list. \n* When the base object for the event is not associated with `Account`, `ccEmailType` must be `TenantAdmin`, `RunOwner`, or `SpecificEmail`. "
},
"description": {
"type": "string",
"maxLength": 255,
"description": "The description of the email template."
},
"toEmailType": {
"enum": [
"BillToContact",
"SoldToContact",
"SpecificEmails",
"TenantAdmin",
"BillToAndSoldToContacts",
"RunOwner",
"AllContacts",
"InvoiceOwnerBillToContact",
"InvoiceOwnerSoldToContact",
"InvoiceOwnerBillToAndSoldToContacts",
"InvoiceOwnerAllContacts"
],
"type": "string",
"description": "Email receive type.\n* When the base object for the event is associated with `Account`, `toEmailType` can be any values in the enum list. \n* When the base object for the event is not associated with `Account`, `toEmailType` must be `TenantAdmin`, `RunOwner`, or `SpecificEmail`. "
},
"emailHeaders": {
"type": "object",
"title": "emailHeader",
"description": "Container for custom email headers. Each custom email header consists of a header name and a header value.\n",
"additionalProperties": {
"type": "string",
"description": "The custom email header consists of a name-value pair:\n\n* Field name: the name of the custom email header.\n\n* Field value: the value of the custom email header. You can add merge fields in the field value. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates\" target=\"_blank\">Merge field syntax for email templates</a>.\n"
}
},
"emailSubject": {
"type": "string",
"description": "The email subject. You can add merge fields in the email subject using angle brackets or double curly brackets. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates\" target=\"_blank\">Merge field syntax for email templates</a>.\n"
},
"encodingType": {
"enum": [
"UTF8",
"Shift_JIS",
"ISO_2022_JP",
"EUC_JP",
"X_SJIS_0213"
],
"type": "string",
"default": "UTF8",
"description": "The endcode type of the email body."
},
"eventCategory": {
"type": "number",
"description": "If you specify this 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"
},
"eventTypeName": {
"type": "string",
"description": "The name of the custom event or custom scheduled event. If you specify this field, the email template is created based on the corresponding custom event or custom scheduled event.\n"
},
"fromEmailType": {
"enum": [
"TenantEmail",
"RunOwner",
"SpecificEmail"
],
"type": "string",
"description": "The type of the email."
},
"ccEmailAddress": {
"type": "string",
"description": "The email CC address."
},
"toEmailAddress": {
"type": "string",
"description": "If toEmailType is SpecificEmail, this field is required."
},
"bccEmailAddress": {
"type": "string",
"format": "email",
"description": "The email bcc address."
},
"fromEmailAddress": {
"type": "string",
"description": "If fromEmailType is SpecificEmail, this field is required."
},
"replyToEmailType": {
"enum": [
"TenantEmail",
"RunOwner",
"SpecificEmail"
],
"type": "string",
"description": "Type of the replyTo email."
},
"eventTypeNamespace": {
"type": "string",
"description": "The namespace of the `eventTypeName` field. The `eventTypeName` has the `user.notification` namespace by default. \n\nNote that if the `eventTypeName` is a standard event type, you must specify the `com.zuora.notification` namespace; otherwise, you will get an error.\n\nFor example, if you want to create an email template on the `OrderActionProcessed` event, you must specify `com.zuora.notification` for this field. \n"
},
"replyToEmailAddress": {
"type": "string",
"description": "If `replyToEmailType` is `SpecificEmail`, this field is required."
}
}
}
POSTCreatePaymentSessionRequest
{
"type": "object",
"example": {
"amount": "100",
"currency": "USD",
"accountId": "402880de8779e14f018779e82905000f",
"paymentGateway": "e884322ab8c711edab030242ac120004",
"processPayment": true
},
"required": [
"accountId",
"currency",
"paymentGateway",
"processPayment"
],
"properties": {
"amount": {
"type": "number",
"description": "The amount of the payment.\n\nThis field is required if `processPayment` is `true`.\n"
},
"currency": {
"type": "string",
"description": "The currency of the payment in the format of the three-character ISO currency code.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account in Zuora that is associated with this payment method.\n"
},
"authAmount": {
"type": "number",
"description": "The authorization amount for the payment method. Specify a value greater than 0.\n\nThis field is required if `processPayment` is false.\n"
},
"paymentGateway": {
"type": "string",
"description": "The ID of the payment gateway instance configured in Zuora that will process the payment, such as `e884322ab8c711edab030242ac120004`.\n"
},
"processPayment": {
"type": "boolean",
"description": "Indicate whether a payment should be processed after creating the payment method.\n\nIf this field is set to `true`, you must specify the `amount` field.\n\nIf this field is set to `false`, you must specify the `authAmount` field. The payment method will be verified through the payment gateway instance specified in the `paymentGateway` field.\n"
}
}
}
POSTCreatePaymentSessionResponse
{
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "The token for the payment session data. Send the token back to your client side for identifying your website to Zuora.\n\nFor 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_gateway_integrations_other_than_Adyen_Integration_v2.0).\n"
}
}
}
POSTDecryptResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"publicKey": {
"type": "string",
"description": "The public key passed in as a request parameter.\n"
},
"signature": {
"type": "string",
"description": "The signature passed in as a request parameter.\n"
},
"decryptedSignature": {
"type": "string",
"description": "The string of a list of the following items: Payment Pages 2.0 URL, tenant ID, timestamp,the Payment Page ID\n\nThe items are separated by '#', e.g., \"/apps/publichostedpagelite.do#12271#rvBp1AxBJwk6FrT7aqFuABIINiRbwJCc\n#1418848373103#2c92c0f948f899\"\n"
}
}
}
POSTDecryptionType
{
"type": "object",
"example": {
"method": "POST",
"publicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmWRFTwxQOqaG4JDZSQF/NJWvCDoSXm3TYilNzoN8nBbuvhKa7SZBBS+VP6rFqcbIU38Fu+Rf09vqyYOxuasPJe7yhqeOiStWB/aCPLhwXBeKt37L/qkwpNOKb1FETtUgrc+UjbtT0pnl55wCfi+Ik//X5SQi0B+c0ei1DQv99qmPJJErrhnBtdxeaWAT0EYAo42AOQ5cp0UWDY6OdOYL6+RyFOUFIs1yEgtfg4VMMSpSOKBOhYclQYuSC7nBF5Cc18ydtzsBpf7l49gCLTFzG45NCDAocada8KihFNpGXbauV9V4EPRD4lofaXdsXJ5Tw8/+KCsrUlvIQI3vcEv9LQIDAQAB",
"signature": "BeNYuHFkp/sbfm3clYyCkKEqd7XVTRDOJ1/5rL0tpkqxiSq+maqYkDz5kA+lN64ipoefQuJ7Rdm5TpICErufeJfa2sfTmGARDJ0hr+StXfLsIxHmDoNH5dqcXv3W6MR4kaljEqPVuhzGQ0We98DG52JcHWqqN53oHwTyuZuXocQqnmiE23IPm8UrU3g4hX/OLat0R81wDQ1SslZ+4pnqlncpTpopCK4FxeG3B0gYMhZcYd17Cmf0N3tEHVXHDlJIm4rOx0OVT+YBnjbKYLM0jxYu7PRKRis+yzN1BoappOEB0gmPjznIeiYF0u/fJdZWoEwK7d9mrfJeOBbpFyRoHA=="
},
"required": [
"method",
"publicKey",
"signature"
],
"properties": {
"method": {
"type": "string",
"description": "The type of the request. Set it to POST.\n"
},
"publicKey": {
"type": "string",
"description": "The public key generated by Zuora.\n"
},
"signature": {
"type": "string",
"description": "The signature generated by Zuora.\n"
}
}
}
POSTDelayAuthorizeCapture
{
"type": "object",
"example": {
"amount": 1.99,
"accountId": "402881e861bd8a7e0161c6a453750026",
"accountNumber": "A00000004",
"gatewayOrderId": "A001",
"softDescriptor": "Service fee",
"softDescriptorPhone": "400-000-1234"
},
"required": [
"amount",
"gatewayOrderId"
],
"properties": {
"amount": {
"type": "number",
"description": "The amount of the trasaction."
},
"accountId": {
"type": "string",
"description": "The ID of the customer account. Either `accountId` or `accountNumber` is required."
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account. Either `accountNumber` or `accountId` is required."
},
"gatewayOptions": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The name of a gateway-specific parameter.\n"
},
"value": {
"type": "string",
"description": "The value of the gateway-specific parameter.\n"
}
},
"description": "The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).\n\nZuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.\n"
},
"gatewayOrderId": {
"type": "string",
"description": "The order ID for the specific gateway.\n\nThe specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field.\n"
},
"softDescriptor": {
"type": "string",
"description": "A text, rendered on a cardholder’s statement, describing a particular product or service purchased by the cardholder."
},
"paymentGatewayId": {
"type": "string",
"description": "The ID of the payment gateway instance."
},
"softDescriptorPhone": {
"type": "string",
"description": "The phone number that relates to the soft descriptor, usually the phone number of customer service."
},
"mitTransactionSource": {
"enum": [
"C_Unscheduled",
"M_Recurring",
"M_Unscheduled",
"M_MOTO"
],
"type": "string",
"description": "Payment transaction source used to differentiate the transaction source in Stored Credential Transaction framework.\n - `C_Unscheduled`: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates.\n - `M_Recurring`: Merchant-initiated transaction (MIT) that occurs at regular intervals.\n - `M_Unscheduled`: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates.\n - `M_MOTO`: Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See [Overview of Stripe payment gateway integration](https://knowledgecenter.zuora.com/Zuora_Collect/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration) for more information.\n"
}
}
}
POSTEmailBillingDocfromBillRunType
{
"type": "object",
"example": {
"resend": "true"
},
"properties": {
"resend": {
"type": "boolean",
"default": false,
"description": "Whether to send out emails for all the billing documents that are associated with the bill run. If the value is `false`, emails are sent out only for the billing documents that never have emails sent out.\n"
}
}
}
POSTExecuteInvoiceScheduleRequest
{
"allOf": [
{
"type": "object",
"properties": {
"scheduleItemId": {
"type": "string",
"description": "The ID of the invoice schedule item to be executed.\n\nThe item must be the earliest pending schedule item. If all the invoice schedule items have been processed and credit is needed to be generated, do not specify this field in the request.\n"
}
}
},
{}
],
"example": {
"scheduleItemId": "8ad09b7d82b5c62f0182c5cd16944f73"
}
}
POSTIneligibleAdjustmentResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"amount": {
"type": "string",
"format": "number",
"description": "The amount of the delivery adjustment.\n"
},
"reason": {
"type": "string",
"description": "The reason for the delivery adjustment.\n"
},
"status": {
"type": "string",
"description": "The status of the delivery adjustment.\n"
},
"eligible": {
"type": "boolean",
"description": "The eligible flag is set as false for an unsuccessful delivery adjustment.\n"
},
"billingDate": {
"type": "string",
"format": "date",
"description": "The billing date of the delivery adjustment.\n"
},
"deliveryDay": {
"type": "string",
"format": "string",
"description": "The delivery adjustment day of the week.\n"
},
"adjustmentId": {
"type": "string",
"format": "UUID",
"description": "The system generated delivery adjustment ID.\n"
},
"chargeNumber": {
"type": "string",
"description": "The charge number in the subscription for which the delivery adjustment is created.\n"
},
"deliveryDate": {
"type": "string",
"format": "date",
"description": "The delivery adjustment date, in `yyyy-mm-dd` format.\n"
},
"errorMessage": {
"type": "string",
"description": "The reason due to which a delivery adjustment is not eligible on the given date. \n"
},
"adjustmentNumber": {
"type": "string",
"format": "string",
"description": "The system generated delivery adjustment number.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "The subscription number for which the delivery adjustment is created.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n\n**Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n\n**Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n\n**Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.\n"
}
}
}
]
}
POSTInvoiceCollectCreditMemosType
{
"type": "object",
"title": "creditMemos",
"properties": {
"id": {
"type": "string",
"description": "The ID of the credit memo.\n"
},
"memoNumber": {
"type": "string",
"description": "The unique identification number of the credit memo.\n"
},
"totalAmount": {
"type": "number",
"format": "double",
"description": "The amount of the credit memo.\n"
}
}
}
POSTInvoiceCollectInvoicesType
{
"type": "object",
"title": "invoices",
"properties": {
"invoiceId": {
"type": "string",
"description": "The ID of the invoice.\n"
},
"invoiceAmount": {
"type": "string",
"format": "decimal",
"description": "The amount of the invoice.\n"
},
"invoiceNumber": {
"type": "string",
"description": "The unique identification number of the invoice.\n"
}
}
}
POSTInvoiceCollectResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTInvoiceCollectInvoicesType"
},
"description": "Information on one or more invoices associated with this operation.\n"
},
"paymentId": {
"type": "string",
"description": "Payment ID.\n"
},
"creditMemos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTInvoiceCollectCreditMemosType"
},
"description": "Information on one or more credit memos associated with this operation.\n"
},
"amountCollected": {
"type": "number",
"format": "double",
"description": "Payment amount applied.\n"
}
}
}
POSTInvoiceCollectType
{
"type": "object",
"example": {
"invoiceId": "4028925a4cb74ec9014cb7540988002e",
"accountKey": "4028925a4cb74ec9014cb7520fc00005",
"paymentGateway": "TestGateway"
},
"required": [
"accountKey"
],
"properties": {
"invoiceId": {
"type": "string",
"description": "The ID of an existing invoice for which to collect payment using\nthe account's default payment method. If this value is specified, no new\ninvoice is generated, and the following fields are ignored:\n - `invoiceDate` and `invoiceTargetDate` (if the Zuora REST API version is 214.0 or earlier)\n - `documentDate` and `targetDate` (if the Zuora REST API version is 215.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version))\n"
},
"accountKey": {
"type": "string",
"description": "Customer account ID or account number.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The date through which to calculate charges on this account if an invoice or a credit memo is generated, \nin `yyyy-mm-dd` format. If this field is omitted\nand `invoiceId` is not specified, the current date is used by default. \n\n\n**Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.\n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `215.0` and later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). To use this field in the method, you\nmust set the `zuora-version` parameter to the minor version number in\nthe request header.\n"
},
"invoiceDate": {
"type": "string",
"format": "date",
"description": "**Note:** This field has been replaced by the `documentDate` field in Zuora REST API version `215.0` and later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). The\n`invoiceDate` field is only available for backward\ncompatibility.\n\nThe date that should appear on the invoice being generated,\nin `yyyy-mm-dd` format. If this field is omitted\nand `invoiceId` is not specified, the current date is used by default. \n\nThis field is in Zuora REST API version control. Supported minor\nversions are `214.0` and earlier [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"documentDate": {
"type": "string",
"format": "date",
"description": "The date that should appear on the invoice and credit memo being generated,\nin `yyyy-mm-dd` format. If this field is omitted\nand `invoiceId` is not specified, the current date is used by default. \n\n\n**Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.\n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `215.0` and later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). To use this field in the method, you\nmust set the `zuora-version` parameter to the minor version number in\nthe request header.\n"
},
"invoiceNumber": {
"type": "string",
"description": "The number of an existing invoice for which to collect payment using\nthe account's default payment method. If this value is specified, no new\ninvoice is generated, and the following fields are ignored:\n - `invoiceDate` and `invoiceTargetDate` (if the Zuora REST API version is 214.0 or earlier)\n - `documentDate` and `targetDate` (if the Zuora REST API version is 215.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version))\n"
},
"paymentGateway": {
"type": "string",
"description": "The name of the gateway that will be used for the payment. Must be a valid gateway name and the gateway must support the specific payment method. If a value is not specified, the default gateway on the Account will be used.\n"
},
"invoiceTargetDate": {
"type": "string",
"format": "date",
"description": "**Note:** This field has been replaced by the `targetDate` field in Zuora REST API version `215.0` and later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). The\n`invoiceTargetDate` field is only available for backward\ncompatibility.\n\n\nThe date through which to calculate charges on this account if an invoice is generated, in `yyyy-mm-dd` format. If this field is omitted\nand `invoiceId` is not specified, the current date is used by default. \n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `214.0` and earlier [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). \n"
}
}
}
POSTInvoicesBatchPostType
{
"allOf": [
{
"type": "object",
"properties": {
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoicePostType"
},
"title": "invoices",
"description": "The container for invoices to be posted. The maximum number of invoices to be posted is 50 in one request.\n"
}
}
}
],
"example": {
"invoices": [
{
"id": "402890555a7e9791015a7f15fe440123X",
"invoiceDate": "2022-10-12",
"complexity__c": "Middle",
"description__c": "description"
},
{
"id": "402890555a7e9791015a7f15fe44013aX",
"invoiceDate": "2022-10-12",
"complexity__c": "Middle",
"description__c": "description"
},
{
"id": "402890555a7e9791015a7f15fe44012b",
"invoiceDate": "2022-10-12",
"complexity__c": "Middle",
"description__c": "description"
}
]
}
}
POSTJournalEntryItemType
{
"allOf": [
{
"type": "object",
"required": [
"accountingCodeName",
"type",
"amount"
],
"properties": {
"type": {
"enum": [
"Credit",
"Debit"
],
"type": "string",
"description": "Type of journal entry item. "
},
"amount": {
"type": "string",
"format": "decimal",
"description": "Journal entry item amount in transaction currency.\n"
},
"accountingCodeName": {
"type": "string",
"description": "Name of the accounting code.\n"
},
"accountingCodeType": {
"enum": [
"AccountsReceivable",
"On-Account Receivable",
"Cash",
"OtherAssets",
"CustomerCashOnAccount",
"DeferredRevenue",
"SalesTaxPayable",
"OtherLiabilities",
"SalesRevenue",
"SalesDiscounts",
"OtherRevenue",
"OtherEquity",
"BadDebt",
"OtherExpenses"
],
"type": "string",
"description": "Accounting code type. This field is required if `accountingCodeName` is not unique.\n\nNote that `On-Account Receivable` is only available if you enable the Invoice Settlement feature. \n"
},
"homeCurrencyAmount": {
"type": "string",
"format": "decimal",
"description": "Journal entry item amount in home currency.\n\nThis field is required if you have set your home currency for foreign currency conversion. Otherwise, do not pass this field.\n"
}
}
},
{
"$ref": "#/components/schemas/JournalEntryItemObjectCustomFields"
}
],
"title": "journalEntryItems"
}
POSTJournalEntryResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"journalEntryNumber": {
"type": "string",
"description": "Journal entry number in the format JE-00000001.\n"
}
}
}
POSTJournalEntrySegmentType
{
"type": "object",
"title": "segments",
"required": [
"segmentName",
"segmentValue"
],
"properties": {
"segmentName": {
"type": "string",
"description": "Name of segment. You must use the segment name that has already been specified in the default segment rule. In addition, segments need to be passed in the order where they were defined in the segmentation rule. If multiple segments are configured in the default rule, you need to specify all of them in order. "
},
"segmentValue": {
"type": "string",
"description": "Value of segment in this summary journal entry.\n"
}
}
}
POSTJournalEntryType
{
"allOf": [
{
"type": "object",
"required": [
"journalEntryDate",
"accountingPeriodName",
"currency",
"journalEntryItems"
],
"properties": {
"notes": {
"type": "string",
"description": "The number associated with the revenue event.\n\nCharacter limit: 2,000\n"
},
"currency": {
"type": "string",
"description": "The type of currency used. Currency must be active.\n"
},
"segments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTJournalEntrySegmentType"
},
"description": "List of segments that apply to the summary journal entry.\n"
},
"journalEntryDate": {
"type": "string",
"format": "date",
"description": "Date of the journal entry.\n"
},
"journalEntryItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTJournalEntryItemType"
},
"description": "Key name that represents the list of journal entry items.\n"
},
"organizationLabel": {
"type": "string",
"description": "Name of the organization that the journal entry belongs to. \n\nThis field is only required when you have already turned on Multi-Org feature. \n"
},
"accountingPeriodName": {
"type": "string",
"description": "Name of the accounting period. The open-ended accounting period is named `Open-Ended`.\n"
},
"transferredToAccounting": {
"enum": [
"No",
"Processing",
"Yes",
"Error",
"Ignore"
],
"type": "string",
"description": "Status shows whether the journal entry has been transferred to an accounting system.\n"
}
}
},
{
"$ref": "#/components/schemas/JournalEntryObjectCustomFields"
}
],
"example": {
"notes": "my account",
"currency": "USD",
"segments": [
{
"segmentName": "billToCountry",
"segmentValue": "United States"
},
{
"segmentName": "billToState",
"segmentValue": "California"
}
],
"journalEntryDate": "2014-09-09",
"journalEntryItems": [
{
"type": "Credit",
"amount": "400.9",
"accountingCodeName": "Accounts Receivable",
"accountingCodeType": "Deferred Revenue",
"homeCurrencyAmount": "801.8"
},
{
"type": "Debit",
"amount": "400.9",
"accountingCodeName": "Subscription Revenue",
"accountingCodeType": "Sales Revenue",
"homeCurrencyAmount": "801.8"
}
],
"accountingPeriodName": "Nov-2014",
"transferredToAccounting": "No"
}
}
POSTJournalRunResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"journalRunNumber": {
"type": "string",
"description": "Journal run number.\n"
}
}
}
POSTJournalRunTransactionType
{
"type": "object",
"title": "transactionTypes",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"Invoice Item",
"Taxation Item",
"Invoice Item Adjustment (Invoice)",
"Invoice Item Adjustment (Tax)",
"Invoice Adjustment",
"Electronic Payment",
"External Payment",
"Electronic Refund",
"External Refund",
"Electronic Credit Balance Payment",
"External Credit Balance Payment",
"Electronic Credit Balance Refund",
"External Credit Balance Refund",
"Credit Balance Adjustment (Applied from Credit Balance)",
"Credit Balance Adjustment (Transferred to Credit Balance)",
"Revenue Event Item",
"Debit Memo Item (Charge)",
"Debit Memo Item (Tax)",
"Credit Memo Item (Charge)",
"Credit Memo Item (Tax)",
"Credit Memo Application Item",
"Electronic Payment Application",
"External Payment Application",
"Electronic Refund Application",
"External Refund Application",
"Electronic Payment Application Item",
"External Payment Application Item",
"Electronic Refund Application Item",
"External Refund Application Item"
],
"type": "string",
"description": "Transaction type. Invoice Adjustment is deprecated on Production. Zuora recommends that you use the Invoice Item Adjustment instead.\n\nIf you enable the Invoice Settlement feature, Debit Memo Item, Credit Memo Item, and Credit Memo Application Item are available, Payment and Refund will be replaced by Payment Application and Refund Application. \n\nIf you enable both the Invoice Settlement feature and the Invoice Item Settlement feature, Payment and Refund will be replaced by Payment Application Item and Refund Application Item. \n"
}
}
}
POSTJournalRunType
{
"type": "object",
"example": {
"journalEntryDate": "2014-11-04",
"transactionTypes": [
{
"type": "Invoice Item"
},
{
"type": "Revenue Event Item"
}
],
"accountingPeriodName": "Nov-2014"
},
"required": [
"transactionTypes",
"journalEntryDate"
],
"properties": {
"targetEndDate": {
"type": "string",
"format": "date",
"description": "The target end date of the journal run.\n\nIf you include `accountingPeriodName`, the `targetEndDate` must be empty or the same as the end date of the accounting period specified in `accountingPeriodName`.\n"
},
"targetStartDate": {
"type": "string",
"format": "date",
"description": "The target start date of the journal run.\n\nRequired if you include targetEndDate.\n\nIf you include `accountingPeriodName`, the `targetStartDate` must be empty or the same as the start date of the accounting period specified in `accountingPeriodName`.\n"
},
"journalEntryDate": {
"type": "string",
"format": "date",
"description": "Date of the journal entry.\n"
},
"transactionTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTJournalRunTransactionType"
},
"description": "Transaction types included in the journal run.\n\nYou can include one or more transaction types.\n"
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organizations that this run is created for. \n\nFor each item in the array, either the `organizationId` or the `organizationName` field is required.\n\nThis field is only required when you have already turned on Multi-Org feature.\n"
},
"accountingPeriodName": {
"type": "string",
"description": "Name of the accounting period.\n\nThis field determines the target start and end dates of the journal run.\n\nRequired if you do not include `targetStartDate` and `targetEndDate`.\n"
}
}
}
POSTMassUpdateResponseType
{
"type": "object",
"properties": {
"bulkKey": {
"type": "string",
"description": "String of 32 characters that identifies the mass action. The bulkKey is generated before the mass action is processed. You can use the bulkKey to Get the Mass Action Result.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
}
}
}
POSTMemoPdfResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
}
}
}
POSTOrderAsyncRequestType
{
"type": "object",
"example": {
"orderDate": "2017-01-01",
"description": "This is a description for the Order.",
"orderNumber": "OM-00001",
"subscriptions": [
{
"orderActions": [
{
"type": "CreateSubscription",
"triggerDates": [
{
"name": "ContractEffective",
"triggerDate": "2017-01-01"
}
],
"createSubscription": {
"terms": {
"autoRenew": true,
"initialTerm": {
"period": 12,
"termType": "TERMED",
"startDate": "2017-01-01",
"periodType": "Month"
},
"renewalTerms": [
{
"period": 12,
"periodType": "Month"
}
],
"renewalSetting": "RENEW_WITH_SPECIFIC_TERM"
},
"paymentTerm": "Net 30",
"sequenceSetId": "6abcc30846de11e990900242ac1f0003",
"billToContactId": "efbff07e6290dfb8016291003bd00dda",
"soldToContactId": "efbff07e6290dfb8016291003bd00ddb",
"invoiceTemplateId": "2c9081a03c638994013c63978baf002b",
"subscriptionNumber": "SM-00001",
"subscribeToRatePlans": [
{
"productRatePlanId": "efbff07e6290dfb8016291003bd00dda"
}
]
}
}
]
},
{
"orderActions": [
{
"type": "CreateSubscription",
"triggerDates": [
{
"name": "ServiceActivation",
"triggerDate": "2017-02-01"
}
],
"createSubscription": {
"terms": {
"autoRenew": true,
"initialTerm": {
"period": 12,
"termType": "TERMED",
"startDate": "2017-02-01",
"periodType": "Month"
},
"renewalTerms": [
{
"period": 12,
"periodType": "Month"
}
],
"renewalSetting": "RENEW_WITH_SPECIFIC_TERM"
},
"subscriptionNumber": "SM-00002",
"subscribeToRatePlans": [
{
"productRatePlanId": "efbff07e6290dfb8016291003bd00dda"
}
]
}
}
]
},
{
"orderActions": [
{
"type": "CreateSubscription",
"triggerDates": [
{
"name": "ServiceActivation",
"triggerDate": "2017-03-01"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2017-04-01"
}
],
"createSubscription": {
"terms": {
"autoRenew": true,
"initialTerm": {
"period": 12,
"termType": "TERMED",
"startDate": "2017-01-01",
"periodType": "Month"
},
"renewalTerms": [
{
"period": 12,
"periodType": "Month"
}
],
"renewalSetting": "RENEW_WITH_SPECIFIC_TERM"
},
"subscriptionNumber": "SM-00003",
"subscribeToRatePlans": [
{
"productRatePlanId": "efbff07e6290dfb80162910024c80dd5"
}
]
}
}
]
},
{
"orderActions": [
{
"type": "CreateSubscription",
"triggerDates": [
{
"name": "ServiceActivation",
"triggerDate": "2017-03-01"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2017-04-01"
}
],
"createSubscription": {
"terms": {
"autoRenew": true,
"initialTerm": {
"period": 12,
"termType": "TERMED",
"startDate": "2017-01-01",
"periodType": "Month"
},
"renewalTerms": [
{
"period": 12,
"periodType": "Month"
}
],
"renewalSetting": "RENEW_WITH_SPECIFIC_TERM"
},
"subscriptionNumber": "SM-00004",
"subscribeToRatePlans": [
{
"uniqueToken": "Sugar-free Monthly",
"chargeOverrides": [
{
"startDate": {
"triggerEvent": "SpecificDate"
},
"productRatePlanChargeId": "efbff07e6290dfb80162910024d80dd7"
}
],
"productRatePlanId": "efbff07e6290dfb80162910024c80dd5"
}
]
}
}
]
},
{
"orderActions": [
{
"type": "Suspend",
"suspend": {
"suspendPolicy": "FixedPeriodsFromToday",
"suspendPeriods": 2,
"suspendPeriodsType": "Week"
},
"triggerDates": [
{
"name": "ContractEffective",
"triggerDate": "2018-01-01"
},
{
"name": "ServiceActivation",
"triggerDate": "2018-01-01"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2018-01-01"
}
]
}
],
"subscriptionNumber": "SM-00005"
},
{
"orderActions": [
{
"type": "Resume",
"resume": {
"extendsTerm": true,
"resumePolicy": "SpecificDate",
"resumeSpecificDate": "2018-10-01"
},
"triggerDates": [
{
"name": "ContractEffective",
"triggerDate": "2018-01-01"
},
{
"name": "ServiceActivation",
"triggerDate": "2018-01-01"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2018-01-01"
}
]
}
],
"subscriptionNumber": "SM-00006"
}
],
"orderLineItems": [
{
"soldTo": "4028fc828244a0ac018244dfc9a90bee",
"taxCode": "8018",
"taxMode": "TaxInclusive",
"itemName": "webcam",
"itemType": "Product",
"quantity": 2,
"description": "With Dual Stereo Microphones, HD 1080p, Black",
"productCode": "C9201",
"customFields": {
"someField__c": "some string"
},
"billingTrigger": "BillImmediately",
"listPricePerUnit": 59,
"ownerAccountNumber": "AN_1683614809986",
"transactionEndDate": "2021-02-01",
"chargeAmountPerUnit": 50,
"purchaseOrderNumber": "960-000764",
"transactionStartDate": "2021-02-01",
"revenueRecognitionRule": "recognized upon invoice",
"deferredRevenueAccountingCode": "Unearned Revenues",
"recognizedRevenueAccountingCode": "Earned Revenues"
}
],
"processingOptions": {
"runBilling": true,
"billingOptions": {
"targetDate": "2017-08-01",
"creditMemoReasonCode": "Unsatisfactory service"
},
"collectPayment": true,
"applyCreditBalance": true,
"electronicPaymentOptions": {
"paymentMethodId": "2c9890186cb7c157016cd18c6f690999",
"paymentGatewayId": "2c9890186cb7c157016cd18c72370999"
}
},
"existingAccountNumber": "A00000001"
},
"required": [
"orderDate"
],
"properties": {
"category": {
"enum": [
"NewSales",
"Return"
],
"type": "string",
"default": "NewSales",
"description": "Category of the order to indicate a product sale or return. Default value is `NewSales`.\n"
},
"orderDate": {
"type": "string",
"format": "date",
"description": "The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null."
},
"newAccount": {
"$ref": "#/components/schemas/CreateOrderNewAccount"
},
"reasonCode": {
"type": "string",
"maxLength": 255,
"description": "Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs.\n"
},
"description": {
"type": "string",
"maxLength": 500,
"description": "A description of the order."
},
"orderNumber": {
"type": "string",
"maxLength": 100,
"description": "The order number of the new order. If not provided, system will auto-generate a number for this order. \n**Note:** Make sure the order number does not contain a slash.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderObjectCustomFields"
},
"subscriptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ramp": {
"$ref": "#/components/schemas/RampRequest"
},
"quote": {
"$ref": "#/components/schemas/QuoteObjectFields"
},
"customFields": {
"$ref": "#/components/schemas/SubscriptionObjectCustomFields"
},
"orderActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOrderOrderAction"
},
"description": "The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request."
},
"subscriptionNumber": {
"type": "string",
"description": "Leave this empty to represent new subscription creation. Specify a subscription number to update an existing subscription.\n"
}
}
},
"description": "Each item includes a set of order actions, which will be applied to the same base subscription."
},
"orderLineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderLineItemCommonPostOrder"
},
"description": "[Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services. \n\nWith the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models.\n\n**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 of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n"
},
"processingOptions": {
"$ref": "#/components/schemas/processingOptionsOrdersAsync"
},
"externallyManagedBy": {
"enum": [
"Amazon",
"Apple",
"Google",
"Roku"
],
"type": "string",
"description": "An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.\n"
},
"existingAccountNumber": {
"type": "string",
"maxLength": 70,
"description": "The account number that this order will be created under.\nNote that this actually specifies the invoice owner account of the subscriptions included in this order.\n"
}
}
}
POSTOrderPreviewAsyncRequestType
{
"type": "object",
"example": {
"orderDate": "2018-10-01",
"description": "This is a description for the Order.",
"customFields": {},
"subscriptions": [
{
"orderActions": [
{
"type": "UpdateProduct",
"triggerDates": [
{
"name": "ContractEffective",
"triggerDate": "2018-12-01"
},
{
"name": "ServiceActivation",
"triggerDate": "2018-12-01"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2018-12-01"
}
],
"updateProduct": {
"ratePlanId": "2c98919c67a5ae9d0167a68f8eb20262",
"chargeUpdates": [
{
"pricing": {
"recurringPerUnit": {
"listPrice": 20
}
},
"chargeNumber": "C-00000210"
}
]
}
}
],
"subscriptionNumber": "A-S00000100"
},
{
"orderActions": [
{
"type": "Suspend",
"suspend": {
"suspendPolicy": "Today"
},
"triggerDates": [
{
"name": "ContractEffective",
"triggerDate": "2018-12-01"
},
{
"name": "ServiceActivation",
"triggerDate": "2018-12-01"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2018-12-01"
}
]
}
],
"subscriptionNumber": "A-S00000101"
},
{
"orderActions": [
{
"type": "Resume",
"resume": {
"extendsTerm": true,
"resumePolicy": "FixedPeriodsFromSuspendDate",
"resumePeriods": 10,
"resumePeriodsType": "Day"
},
"triggerDates": [
{
"name": "ContractEffective",
"triggerDate": "2018-12-12"
},
{
"name": "ServiceActivation",
"triggerDate": "2018-12-12"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2018-12-12"
}
]
}
],
"subscriptionNumber": "A-S00000102"
}
],
"orderLineItems": [
{
"taxCode": "8018",
"taxMode": "TaxInclusive",
"itemName": "webcam",
"itemType": "Product",
"quantity": 2,
"description": "With Dual Stereo Microphones, HD 1080p, Black",
"productCode": "C9201",
"customFields": {
"someField__c": "some string"
},
"amountPerUnit": 50,
"billingTrigger": "BillImmediately",
"listPricePerUnit": 59,
"transactionEndDate": "2021-02-01",
"purchaseOrderNumber": "960-000764",
"transactionStartDate": "2021-02-01",
"revenueRecognitionRule": "recognized upon invoice",
"deferredRevenueAccountingCode": "Unearned Revenues",
"recognizedRevenueAccountingCode": "Earned Revenues"
}
],
"previewOptions": {
"previewTypes": [
"OrderMetrics",
"BillingDocs",
"ChargeMetrics"
],
"previewThruType": "SpecificDate",
"specificPreviewThruDate": "2019-01-01"
},
"existingAccountNumber": "A00000101"
},
"required": [
"orderDate",
"previewOptions"
],
"properties": {
"category": {
"enum": [
"NewSales",
"Return"
],
"type": "string",
"default": "NewSales",
"description": "Category of the order to indicate a product sale or return. Default value is `NewSales`.\n"
},
"orderDate": {
"type": "string",
"format": "date",
"description": "The date when the order is signed. All of the order actions under this order will use this order date as the contract effective date."
},
"reasonCode": {
"type": "string",
"maxLength": 255,
"description": "Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs.\n"
},
"description": {
"type": "string",
"maxLength": 500,
"description": "A description of the order."
},
"orderNumber": {
"type": "string",
"maxLength": 100,
"description": "The order number of this order. \n**Note:** Make sure the order number does not contain a slash.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderObjectCustomFields"
},
"subscriptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ramp": {
"$ref": "#/components/schemas/RampRequest"
},
"quote": {
"$ref": "#/components/schemas/QuoteObjectFields"
},
"customFields": {
"$ref": "#/components/schemas/SubscriptionObjectCustomFields"
},
"orderActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreviewOrderOrderAction"
},
"description": "The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request."
},
"subscriptionNumber": {
"type": "string",
"description": "Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription.\n"
}
}
},
"description": "Each item includes a set of order actions, which will be applied to the same base subscription."
},
"orderLineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderLineItemCommonPostOrder"
},
"description": "[Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services. \n\nWith the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models. \n\n**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 of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n"
},
"previewOptions": {
"$ref": "#/components/schemas/PreviewOptions"
},
"previewAccountInfo": {
"$ref": "#/components/schemas/PreviewAccountInfo"
},
"existingAccountNumber": {
"type": "string",
"maxLength": 70,
"description": "The account number that this order will be created under. \nNote that invoice owner account of the subscriptions included in this order should be the same with the account of the order.\n"
}
}
}
POSTOrderPreviewRequestType
{
"type": "object",
"example": {
"orderDate": "2018-10-01",
"description": "This is a description for the Order.",
"customFields": {},
"subscriptions": [
{
"orderActions": [
{
"type": "UpdateProduct",
"triggerDates": [
{
"name": "ContractEffective",
"triggerDate": "2018-12-01"
},
{
"name": "ServiceActivation",
"triggerDate": "2018-12-01"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2018-12-01"
}
],
"updateProduct": {
"ratePlanId": "2c98919c67a5ae9d0167a68f8eb20262",
"chargeUpdates": [
{
"pricing": {
"recurringPerUnit": {
"listPrice": 20
}
},
"chargeNumber": "C-00000210"
}
]
}
}
],
"subscriptionNumber": "A-S00000100"
},
{
"orderActions": [
{
"type": "Suspend",
"suspend": {
"suspendPolicy": "Today"
},
"triggerDates": [
{
"name": "ContractEffective",
"triggerDate": "2018-12-01"
},
{
"name": "ServiceActivation",
"triggerDate": "2018-12-01"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2018-12-01"
}
]
}
],
"subscriptionNumber": "A-S00000101"
},
{
"orderActions": [
{
"type": "Resume",
"resume": {
"extendsTerm": true,
"resumePolicy": "FixedPeriodsFromSuspendDate",
"resumePeriods": 10,
"resumePeriodsType": "Day"
},
"triggerDates": [
{
"name": "ContractEffective",
"triggerDate": "2018-12-12"
},
{
"name": "ServiceActivation",
"triggerDate": "2018-12-12"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2018-12-12"
}
]
}
],
"subscriptionNumber": "A-S00000102"
}
],
"orderLineItems": [
{
"billTo": "2c9081a03c6d7b51013c6d7e2dfc09fa",
"soldTo": "4028fc828244a0ac018244dfc9a90bee",
"taxCode": "8018",
"taxMode": "TaxInclusive",
"itemName": "webcam",
"itemType": "Product",
"quantity": 2,
"description": "With Dual Stereo Microphones, HD 1080p, Black",
"productCode": "C9201",
"customFields": {
"someField__c": "some string"
},
"amountPerUnit": 50,
"billingTrigger": "BillImmediately",
"listPricePerUnit": 59,
"transactionEndDate": "2021-02-01",
"purchaseOrderNumber": "960-000764",
"transactionStartDate": "2021-02-01",
"revenueRecognitionRule": "recognized upon invoice",
"deferredRevenueAccountingCode": "Unearned Revenues",
"recognizedRevenueAccountingCode": "Earned Revenues"
}
],
"previewOptions": {
"previewTypes": [
"OrderMetrics",
"BillingDocs",
"ChargeMetrics"
],
"previewThruType": "SpecificDate",
"specificPreviewThruDate": "2019-01-01"
},
"existingAccountNumber": "A00000101"
},
"required": [
"orderDate",
"previewOptions"
],
"properties": {
"category": {
"enum": [
"NewSales",
"Return"
],
"type": "string",
"default": "NewSales",
"description": "Category of the order to indicate a product sale or return. Default value is `NewSales`.\n"
},
"orderDate": {
"type": "string",
"format": "date",
"description": "The date when the order is signed. All of the order actions under this order will use this order date as the contract effective date."
},
"reasonCode": {
"type": "string",
"maxLength": 255,
"description": "Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs.\n"
},
"description": {
"type": "string",
"maxLength": 500,
"description": "A description of the order."
},
"orderNumber": {
"type": "string",
"maxLength": 100,
"description": "The order number of this order. \n**Note:** Make sure the order number does not contain a slash.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderObjectCustomFields"
},
"subscriptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ramp": {
"$ref": "#/components/schemas/RampRequest"
},
"quote": {
"$ref": "#/components/schemas/QuoteObjectFields"
},
"customFields": {
"$ref": "#/components/schemas/SubscriptionObjectCustomFields"
},
"orderActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreviewOrderOrderAction"
},
"description": "The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request."
},
"subscriptionNumber": {
"type": "string",
"description": "Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription.\n"
}
}
},
"description": "Each item includes a set of order actions, which will be applied to the same base subscription."
},
"orderLineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderLineItemCommonPostOrder"
},
"description": "[Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services. \n\nWith the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models. \n\n**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 of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n"
},
"previewOptions": {
"$ref": "#/components/schemas/PreviewOptions"
},
"previewAccountInfo": {
"$ref": "#/components/schemas/PreviewAccountInfo"
},
"existingAccountNumber": {
"type": "string",
"maxLength": 70,
"description": "The account number that this order will be created under. \nNote that invoice owner account of the subscriptions included in this order should be the same with the account of the order.\n"
}
}
}
POSTOrderRequestType
{
"type": "object",
"example": {
"orderDate": "2017-01-01",
"description": "This is a description for the Order.",
"orderNumber": "OM-00001",
"subscriptions": [
{
"orderActions": [
{
"type": "CreateSubscription",
"triggerDates": [
{
"name": "ServiceActivation",
"triggerDate": "2017-03-01"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2017-04-01"
}
],
"createSubscription": {
"terms": {
"autoRenew": true,
"initialTerm": {
"period": 12,
"termType": "TERMED",
"startDate": "2017-01-01",
"periodType": "Month"
},
"renewalTerms": [
{
"period": 12,
"periodType": "Month"
}
],
"renewalSetting": "RENEW_WITH_SPECIFIC_TERM"
},
"subscriptionNumber": "SM-00004",
"subscribeToRatePlans": [
{
"uniqueToken": "Sugar-free Monthly",
"chargeOverrides": [
{
"startDate": {
"triggerEvent": "SpecificDate"
},
"productRatePlanChargeId": "efbff07e6290dfb80162910024d80dd7"
}
],
"productRatePlanId": "efbff07e6290dfb80162910024c80dd5",
"subscriptionRatePlanNumber": "SRP-001"
}
]
}
}
]
},
{
"orderActions": [
{
"type": "Suspend",
"suspend": {
"suspendPolicy": "FixedPeriodsFromToday",
"suspendPeriods": 2,
"suspendPeriodsType": "Week"
},
"triggerDates": [
{
"name": "ContractEffective",
"triggerDate": "2018-01-01"
},
{
"name": "ServiceActivation",
"triggerDate": "2018-01-01"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2018-01-01"
}
]
}
],
"subscriptionNumber": "SM-00005"
},
{
"orderActions": [
{
"type": "Resume",
"resume": {
"extendsTerm": true,
"resumePolicy": "SpecificDate",
"resumeSpecificDate": "2018-10-01"
},
"triggerDates": [
{
"name": "ContractEffective",
"triggerDate": "2018-01-01"
},
{
"name": "ServiceActivation",
"triggerDate": "2018-01-01"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2018-01-01"
}
]
}
],
"subscriptionNumber": "SM-00006"
}
],
"orderLineItems": [
{
"billTo": "2c9081a03c6d7b51013c6d7e2dfc09fa",
"soldTo": "4028fc828244a0ac018244dfc9a90bee",
"taxCode": "8018",
"taxMode": "TaxInclusive",
"itemName": "webcam",
"itemType": "Product",
"quantity": 2,
"description": "With Dual Stereo Microphones, HD 1080p, Black",
"productCode": "C9201",
"customFields": {
"someField__c": "some string"
},
"billingTrigger": "BillImmediately",
"listPricePerUnit": 59,
"ownerAccountNumber": "AN_1683614809986",
"transactionEndDate": "2021-02-01",
"chargeAmountPerUnit": 50,
"purchaseOrderNumber": "960-000764",
"transactionStartDate": "2021-02-01",
"revenueRecognitionRule": "recognized upon invoice",
"deferredRevenueAccountingCode": "Unearned Revenues",
"recognizedRevenueAccountingCode": "Earned Revenues"
}
],
"processingOptions": {
"runBilling": true,
"billingOptions": {
"targetDate": "2017-08-01",
"creditMemoReasonCode": "Unsatisfactory service"
},
"collectPayment": true,
"applyCreditBalance": true,
"electronicPaymentOptions": {
"gatewayOrderId": "A001",
"paymentMethodId": "2c9890186cb7c157016cd18c6f690999",
"paymentGatewayId": "2c9890186cb7c157016cd18c72370999",
"authTransactionId": "pi_3OER45dashnqYj"
}
},
"existingAccountNumber": "A00000001"
},
"required": [
"orderDate"
],
"properties": {
"status": {
"enum": [
"Draft",
"Pending",
"Completed",
"Scheduled",
"Executing",
"Failed"
],
"type": "string",
"description": "The status of the order. The default value is `Completed`. The following values are supported:\n- `Draft`: The order is in draft status.\n- `Pending`: The order is in pending status.\n- `Completed`: The order is in completed status.\n- `Scheduled`: The order is in scheduled status and it is only valid if the Scheduled Orders feature is enabled.\n- `Executing`: The scheduled order is executed by a scheduler and it is only valid if the Scheduled Orders feature is enabled.\n- `Failed`: The scheduled order has failed.\n"
},
"category": {
"enum": [
"NewSales",
"Return"
],
"type": "string",
"default": "NewSales",
"description": "Category of the order to indicate a product sale or return. Default value is `NewSales`.\n"
},
"orderDate": {
"type": "string",
"format": "date",
"description": "The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null."
},
"newAccount": {
"$ref": "#/components/schemas/CreateOrderNewAccount"
},
"reasonCode": {
"type": "string",
"maxLength": 255,
"description": "Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs.\n"
},
"description": {
"type": "string",
"maxLength": 500,
"description": "A description of the order."
},
"orderNumber": {
"type": "string",
"maxLength": 100,
"description": "The order number of the new order. If not provided, system will auto-generate a number for this order. \n**Note:** Make sure the order number does not contain a slash. \n"
},
"customFields": {
"$ref": "#/components/schemas/OrderObjectCustomFields"
},
"subscriptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ramp": {
"$ref": "#/components/schemas/RampRequest"
},
"quote": {
"$ref": "#/components/schemas/QuoteObjectFields"
},
"customFields": {
"$ref": "#/components/schemas/SubscriptionObjectCustomFields"
},
"orderActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOrderOrderAction"
},
"description": "The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request."
},
"subscriptionNumber": {
"type": "string",
"description": "Leave this empty to represent new subscription creation. Specify a subscription number to update an existing subscription.\n"
}
}
},
"description": "Each item includes a set of order actions, which will be applied to the same base subscription."
},
"orderLineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderLineItemCommonPostOrder"
},
"description": "[Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services. \n\nWith the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models.\n\n**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 of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n"
},
"processingOptions": {
"$ref": "#/components/schemas/processingOptionsOrdersWithDelayedCapturePayment"
},
"schedulingOptions": {
"type": "object",
"properties": {
"scheduledDate": {
"type": "string",
"format": "date",
"description": "The date for the order scheduled.\n"
},
"scheduledDatePolicy": {
"enum": [
"SpecificDate"
],
"type": "string",
"description": "Date policy of the scheduled order."
}
},
"description": "Information of scheduled order. \n"
},
"externallyManagedBy": {
"enum": [
"Amazon",
"Apple",
"Google",
"Roku"
],
"type": "string",
"description": "An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.\n"
},
"existingAccountNumber": {
"type": "string",
"maxLength": 70,
"description": "The account number that this order will be created under.\nNote that this actually specifies the invoice owner account of the subscriptions included in this order.\n"
}
}
}
POSTPMMandateInfo
{
"type": "object",
"title": "mandateInfo",
"properties": {
"mandateId": {
"type": "string",
"description": "The mandate ID.\n"
},
"mandateReason": {
"type": "string",
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"description": "The status of the mandate from the gateway side.\n"
},
"mitProfileType": {
"type": "string",
"description": "Indicates the type of the stored credential profile. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field.\n"
},
"mitProfileAction": {
"enum": [
"Activate",
"Persist"
],
"type": "string",
"description": "Specifies how Zuora creates and activates the stored credential profile. Only applicable if you set the `status` field to `Active`.\n\n- `Activate` (default) - Use this value if you are creating the stored credential profile after receiving the customer's consent.\n\n Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile.\n \n If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`.\n\n\n- `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`.\n\nIf you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field.\n"
},
"mitTransactionId": {
"type": "string",
"maxLength": 128,
"description": "Specifies the ID of the transaction. Only applicable if you set the `mitProfileAction` field to `Persist`.\n"
},
"mandateUpdateDate": {
"type": "string",
"format": "date",
"description": "The date on which the mandate was updated.\n"
},
"mitProfileAgreedOn": {
"type": "string",
"format": "date",
"description": "The date on which the stored credential profile is agreed. The date format is `yyyy-mm-dd`.\n"
},
"mandateCreationDate": {
"type": "string",
"format": "date",
"description": "The date on which the mandate was created.\n"
},
"existingMandateStatus": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Indicates whether the mandate is an existing mandate.\n"
},
"mandateReceivedStatus": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Indicates whether the mandate is received from the gateway\n"
},
"mitConsentAgreementRef": {
"type": "string",
"description": "Reference for the consent agreement that you have established with the customer. \n"
},
"mitConsentAgreementSrc": {
"enum": [
"External"
],
"type": "string",
"description": "Required if you set the `mitProfileAction` field. Specifies how the consent agreement has been established with the customer. The allowed value is `External`. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field.\n"
}
},
"description": "The mandate information for the Credit Card, Apple Pay, Google Pay, Credit Card Reference Transaction, ACH, or Bank Transfer payment method.\n\nThe following mandate fields are common to all supported payment methods:\n* `mandateId`\n* `mandateReason`\n* `mandateStatus`\n\nThe following mandate fields are specific to the ACH and Bank Transfer payment methods:\n* `mandateReceivedStatus`\n* `existingMandateStatus`\n* `mandateCreationDate`\n* `mandateUpdateDate`\n\nThe following mandate fields are specific to the Credit Card, Apple Pay, and Google Pay payment methods:\n* `mitTransactionId`\n* `mitProfileAgreedOn`\n* `mitConsentAgreementRef`\n* `mitConsentAgreementSrc`\n* `mitProfileType`\n* `mitProfileAction`\n"
}
POSTPaymentMethodDecryption
{
"type": "object",
"example": {
"accountID": "402891a25a02e11c015a02f3c6100003",
"invoiceId": "INV000000005",
"merchantID": "merchant.CN.com.zuora.services416",
"paymentToken": {
"data": "xGc......JDxuYz1gug0KZRrGXJQ=",
"header": {
"publicKeyHash": "HuLvfqvLon......9jEyX0w=",
"transactionId": "abbadd18818baea1f37b40844c9e09afa9733b0eccb373905b811da43cf1753b",
"ephemeralPublicKey": "MFkwEw......TMbLoojKBA=="
},
"version": "EC_v1",
"signature": "MIAGCSqGSIb......AEtrLSv7hE9gAAAAAAAA=="
},
"mitProfileType": "Recurring",
"paymentGateway": "CyberSourceOPG",
"processPayment": true,
"integrationType": "ApplePay",
"mitProfileAction": "Activate",
"mitConsentAgreementSrc": "External"
},
"required": [
"integrationType",
"merchantID",
"paymentToken"
],
"properties": {
"accountID": {
"type": "string",
"description": "The ID of the customer account associated with this payment method.\nTo create an orphan payment method that is not associated with any customer account, you do not need to specify this field during creation. However, you must associate the orphan payment method with a customer account within 10 days. Otherwise, this orphan payment method will be deleted."
},
"invoiceId": {
"type": "string",
"description": "The id of invoice this payment will apply to.\n\n**Note:** When `processPayment` is `true`, this field is required.\nOnly one invoice can be paid; for scenarios where you want to pay for multiple invoices, set `processPayment` to `false` and call payment API separately.\n"
},
"merchantID": {
"type": "string",
"description": "The Merchant ID that was configured for use with Apple Pay in the Apple iOS Developer Center.\n"
},
"paymentToken": {
"type": "object",
"description": "The complete JSON Object representing the encrypted payment token payload returned in the response from the Apple Pay session.\n\n"
},
"cardHolderInfo": {
"$ref": "#/components/schemas/CreatePaymentMethodCardholderInfo"
},
"mitProfileType": {
"enum": [
"Recurring",
"Unscheduled"
],
"type": "string",
"description": "This field is only available for the following gateway integrations to create stored credential profiles within payment methods:\n - Chase Paymentech Orbital Gateway\n - CyberSource Payment API v2.0\n - Stripe v2\n - Vantiv (Now Worldpay)\n\nThis field indicates the type of the stored credential profile to process recurring or unsecheduled transactions. It is required if the `mitProfileAction` field is specified. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field.\n \n"
},
"paymentGateway": {
"type": "string",
"description": "The label name of the gateway instance configured in Zuora that should process the payment. When creating a Payment, this must be a valid gateway instance ID and this gateway must support the specific payment method. If not specified, the default gateway of your Zuora customer account will be used.\n\n**Note:** When `processPayment` is `true`, this field is required. When `processPayment` is `false`, the default payment gateway of your Zuora customer account will be used no matter whether a payment gateway instance is specified in the `paymentGateway` field.\n"
},
"processPayment": {
"type": "boolean",
"description": "A boolean flag to control whether a payment should be processed after creating payment method. The payment amount will be equivalent to the amount the merchant supplied in the ApplePay session. Default is false.\n\nIf this field is set to `true`, you must specify the `paymentGateway` field with the payment gateway instance name.\n\nIf this field is set to `false`:\n - The default payment gateway of your Zuora customer account will be used no matter whether a payment gateway instance is specified in the `paymentGateway` field. \n - You must select the **Verify new credit card** check box on the gateway instance settings page. Otherwise, the cryptogram will not be sent to the gateway.\n - A separate subscribe or payment API call is required after this payment method creation call.\n"
},
"integrationType": {
"type": "string",
"description": "Field to identify the token decryption type.\n\n**Note:** The only value at this time is `ApplePay`.\n\n"
},
"mitProfileAction": {
"enum": [
"Activate",
"Persist"
],
"type": "string",
"description": "This field is only available for the following gateway integrations to create stored credential profiles within payment methods:\n - Chase Paymentech Orbital Gateway\n - CyberSource Payment API v2.0\n - Stripe v2\n - Vantiv (Now Worldpay)\n\nSpecify either of the following values in this field:\n \n - `Activate` - Use this value if you are creating the stored credential profile after receiving the customer's consent.\n \n Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile.\n \n If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`.\n \n - `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`.\n\n If you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field.\n \n"
},
"mitConsentAgreementSrc": {
"enum": [
"External"
],
"type": "string",
"description": "This field is only available for the following gateway integrations to create stored credential profiles within payment methods:\n - Chase Paymentech Orbital Gateway\n - CyberSource Payment API v2.0\n - Stripe v2\n - Vantiv (Now Worldpay)\n\nSpecify how the consent agreement has been established with the customer. The allowed value is `External`. It is required if the `mitProfileAction` field is specified. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field.\n"
}
}
}
POSTPaymentMethodRequest
{
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/CreatePaymentMethodCreditCard"
},
{
"$ref": "#/components/schemas/CreatePaymentMethodCCReferenceTransaction"
},
{
"$ref": "#/components/schemas/CreatePaymentMethodACH"
},
{
"$ref": "#/components/schemas/CreatePaymentMethodSEPA"
},
{
"$ref": "#/components/schemas/CreatePaymentMethodBetalingsservice"
},
{
"$ref": "#/components/schemas/CreatePaymentMethodAutogiro"
},
{
"$ref": "#/components/schemas/CreatePaymentMethodBacs"
},
{
"$ref": "#/components/schemas/CreatePaymentMethodBecs"
},
{
"$ref": "#/components/schemas/CreatePaymentMethodBecsnz"
},
{
"$ref": "#/components/schemas/CreatePaymentMethodPAD"
},
{
"$ref": "#/components/schemas/CreatePMPayPalNativeEC"
},
{
"$ref": "#/components/schemas/CreatePMPayPalCP"
},
{
"$ref": "#/components/schemas/CreatePMPayPalEC"
},
{
"$ref": "#/components/schemas/CreatePaymentMethodPayPalAdaptive"
},
{
"$ref": "#/components/schemas/CreatePaymentMethodApplePayAdyen"
},
{
"$ref": "#/components/schemas/CreatePaymentMethodGooglePayChase"
}
],
"required": [
"type"
],
"description": "Payment method information associated with an account.",
"discriminator": {
"mapping": {
"ACH": "#/components/schemas/CreatePaymentMethodACH",
"PAD": "#/components/schemas/CreatePaymentMethodPAD",
"Bacs": "#/components/schemas/CreatePaymentMethodBacs",
"Becs": "#/components/schemas/CreatePaymentMethodBecs",
"SEPA": "#/components/schemas/CreatePaymentMethodSEPA",
"Becsnz": "#/components/schemas/CreatePaymentMethodBecsnz",
"Autogiro": "#/components/schemas/CreatePaymentMethodAutogiro",
"PayPalCP": "#/components/schemas/CreatePMPayPalCP",
"PayPalEC": "#/components/schemas/CreatePMPayPalEC",
"GooglePay": "#/components/schemas/CreatePaymentMethodGooglePayChase",
"CreditCard": "#/components/schemas/CreatePaymentMethodCreditCard",
"AdyenApplePay": "#/components/schemas/CreatePaymentMethodApplePayAdyen",
"AdyenGooglePay": "#/components/schemas/CreatePaymentMethodGooglePayAdyen",
"PayPalAdaptive": "#/components/schemas/CreatePaymentMethodPayPalAdaptive",
"PayPalNativeEC": "#/components/schemas/CreatePMPayPalNativeEC",
"Betalingsservice": "#/components/schemas/CreatePaymentMethodBetalingsservice",
"CreditCardReferenceTransaction": "#/components/schemas/CreatePaymentMethodCCReferenceTransaction"
},
"propertyName": "type"
}
}
POSTPaymentMethodResponse
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the payment method that was created.\n"
},
"reasons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error code.\n"
},
"message": {
"type": "string",
"description": "Error message.\n"
}
},
"description": "Error information. Only applicable if the payment method was not created.\n"
}
}
}
}
]
}
POSTPaymentMethodResponseDecryption
{
"type": "object",
"properties": {
"amount": {
"type": "string",
"description": "The payment amount contained within the encrypted token.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"paymentId": {
"type": "string",
"description": "The ID of newly processed payment,\n"
},
"paymentMethodId": {
"type": "string",
"description": "ID of the newly-created payment method.\n"
}
}
}
POSTPaymentMethodUpdaterBatchRequest
{
"type": "object",
"example": {
"billingCycleDay": 5,
"updaterAccountId": "418734b01fbb11ee821f0e4e5eec84cf"
},
"required": [
"updaterAccountId",
"billingCycleDay"
],
"properties": {
"billingCycleDay": {
"type": "integer",
"description": "The billing cycle day. The allowed value is an integer in the range of 1 - 31.\n\nThe payment methods from accounts where the billing cycle day is the specified value in this field will be included in the updates.\n"
},
"updaterAccountId": {
"type": "string",
"description": "The ID (UUID) of the PMU account. This field must be a string of 32 characters consisting of digits and letters a - f.\n"
}
}
}
POSTPaymentMethodUpdaterResponse
{
"type": "object",
"properties": {
"reasons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error code.\n"
},
"message": {
"type": "string",
"description": "Error message.\n"
}
}
},
"description": "The container of the error code and message. This field is available only if the `success` field is `false`.\n"
},
"success": {
"type": "boolean",
"description": "Indicates whether the request to create a PMU batch is sent successfully.\n"
},
"processId": {
"type": "string",
"description": "The ID of the running process when the exception occurs. This field is available only if the `success` field is `false`.\n"
},
"requestId": {
"type": "string",
"description": "The ID of the request. This field is available only if the `success` field is `false`\n"
}
}
}
POSTPaymentRunDataElementRequest
{
"allOf": [
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "The amount to be collected for the specified invoice/debit memo. `amount` must be a positive numeric value no more than the balance of the specified invoice/debit memo.\n\nThis field is only available when `documentId` is specified. If `amount` is not specified, whole balance of the invoice/debit memo is collected.\n"
},
"comment": {
"type": "string",
"description": "Additional comments.\n"
},
"currency": {
"type": "string",
"description": "Note: This field is only available if support for standalone payments is enabled.\n\nThe currency of the standalone payment. Specify this field only if the `standalone` field is `true`. The currency of the standalone payment can be different from the payment currency defined in the customer account settings.\n"
},
"accountId": {
"type": "string",
"description": "A valid account ID associated with the payment run.\n\nIf `consolidatedPayment` is set to `true`, this field is used in processing a single payment for invoices/debit memos due on an account.\n"
},
"dataItems": {
"type": "object",
"title": "dataItems",
"properties": {
"amount": {
"type": "number",
"description": "The total amount to be collected for the specified invoice/debit memo item. The sum of the item amount should be equal to document amount.\n"
},
"taxItemId": {
"type": "string",
"description": "The tax ID of the invoice item or debit memo item.\n"
},
"documentItemId": {
"type": "string",
"description": "The ID of a billing document of the invoice item or debit memo item.\n"
}
},
"description": "The array of data for each Invoice if you want to collect payment for particular items through one payment method. The grouped items are sent as one data record. This field is available if the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Invoice_Item_Settlement/Overview_of_Invoice_Item_Settlement) permission is enabled.\n\nHere is another example for a data item:\n ```\n {\n \"accountId\": \"60c81b5bc51649e8a7d1b48303194790\",\n \"documentId\": \"2c9081a03c63c94c013c6894af5602dd\",\n \"documentType\": \"Invoice\",\n \"dataItems\": [\n {\n \"documentItemId\": \"8a92ab0e8ab14c53018ac746961c10d1\",\n \"amount\": 40\n },\n {\n \"taxItemId\": \"8a92ab0e8ab14c53018ac746961c10d2\",\n \"amount\": 40\n }\n ],\n \"amount\": 80,\n \"paymentMethodId\": \"2c9081a03c6d7b51013c6d7e4ada0a1c\",\n \"paymentGatewayId\": \"d2abe8342e1811ea80e774b9452e17ea\",\n \"comment\": \"Payment Comments\",\n \"customField1__c\": \"cf_value1\",\n \"customField2__c\": \"cf_value2\"\n },\n ```\n"
},
"documentId": {
"type": "string",
"description": "The ID of a billing document associated with the payment run. `documentId` must be valid and match with `documentType`.\n\nYou must either specify both `documentId` and `documentType`, or specify neither of them.\n\nIf neither of `documentType` and `documentId` is specified, all invoices/debit memos with open balance of the account are collected.\n"
},
"standalone": {
"type": "boolean",
"default": false,
"description": "Note: This field is only available if support for standalone payments is enabled.\n\nSpecify `true` to indicate that this is a standalone payment that will be created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. When `standalone` is set to `true`:\n - `accountId` or `accountNumber` is required.\n - `amount` is required. \n - The amount will not be summed up into the account balance and key metrics regardless of the payment currency.\n - No settlement data will be created.\n - Either the applied amount or the unapplied amount of the payment is zero.\n - The standalone payment cannot be applied, unapplied, or transferred.\n"
},
"documentType": {
"enum": [
"Invoice",
"DebitMemo"
],
"type": "string",
"description": "The type of a billing document associated with the payment run. The value can be `Invoice` or `DebitMemo`, but `DebitMemo` is only supported if the Invoice Settlement feature is enabled.\n\nYou must either specify both `documentType` and `documentId`, or specify neither of them.\n\nIf neither of `documentType` and `documentId` is specified, all invoices/debit memos with open balance of the account are collected.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account associated with the payment run, such as `A00000001`.\n\nYou can specify either `accountNumber` or `accountId` for a customer account, but not both of them.\n\nIf `consolidatedPayment` is set to `true`, this field is used in processing a single payment for invoices, debit memos, and standalone payments due on an account.\n"
},
"documentNumber": {
"type": "string",
"description": "The number of a billing document associated with the payment run. `documentNumber` must be valid and match with `documentType`.\n\nYou must either specify both `documentNumber` and `documentType`, or specify neither of them.\n\nIf neither of `documentType` and `documentNumber` is specified, all invoices/debit memos with open balance of the account are collected.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The ID of the payment method for collecting invoices/debit memos. The specified payment method must be a valid non-system payment method. If it is not specified, the default payment method of the account is used regardless of the `autoPay` value of the account.\n\nIf `processPaymentWithClosedPM` is set to `false`, the payment method cannot be closed.\n\nIf the payment retry rules are enabled, the payment method must meet the rules.\n\nIf `consolidatedPayment` is set to `true`, this field is used in processing a single payment for invoices/debit memos due on an account.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "The ID of the payment gateway for collecting invoices/debit memos. The specified payment gateway must be valid and active.\n\nIf <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Payment_Gateway_Routing\" target=\"_blank\">Payment Gateway Routing</a> is enabled: \n - If this field is not specified, gateway routing rules will be invoked.\n - If this field is specified, the specified gateway will be used to process the payment.\n\nIf Payment Gateway Routing is disabled:\n - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant.\n - If this field is specified, the specified gateway will be used to process the payment.\n\nIf `consolidatedPayment` is set to `true`, this field is used in processing a single payment for invoices/debit memos due on an account.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentObjectCustomFields"
}
]
}
POSTPaymentRunRequest
{
"type": "object",
"example": {
"accountId": "402890245f097f39015f0e9fcdd60558",
"targetDate": "2017-10-10",
"autoApplyCreditMemo": "true",
"consolidatedPayment": "true",
"autoApplyUnappliedPayment": "true",
"processPaymentWithClosedPM": "true"
},
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTPaymentRunDataElementRequest"
},
"title": "payment run data",
"description": "\nThe array of data for specifying records of accounts and invoices/debit memos that will be collected and processed by a payment run.\n\nWhen you specify the data array, ensure that at least one record is passed in. If an empty array is specified, `accountId`, `batch`, `billCycleDay`, `currency`, `paymentGatewayId`, and `billingRunId` fields will be used to define the billing documents to be collected. If the [Multiple Currencies](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies) feature is enabled, you can filter the accounts by `currency` based on the customer's billing document.\n\nA maximum of 50K records are allowed to be passed into the `data` array.\n\nHere is an example:\n```\n {\n \"accountId\": \"60c81b5bc51649e8a7d1b48303194790\",\n \"documentId\": \"2c9081a03c63c94c013c6894af5602dd\",\n \"documentType\": \"Invoice\",\n \"amount\": 80,\n \"paymentMethodId\": \"2c9081a03c6d7b51013c6d7e4ada0a1c\",\n \"paymentGatewayId\": \"d2abe8342e1811ea80e774b9452e17ea\",\n \"comment\": \"Payment Comments\",\n \"customField1__c\": \"cf_value1\",\n \"customField2__c\": \"cf_value2\"\n }\n```\n\nHere is another example for a standalone payment:\n```\n {\n \"accountId\": \"account2\",\n \"amount\": 100,\n \"currency\": \"GBP\",\n \"standalone\": true\n }\n```\n"
},
"batch": {
"type": "string",
"description": "The alias name given to a batch. The batch name is a string of 50 characters or less.\n\nThis field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned. \n\n**Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite\" target=\"_blank\">Performance Booster Elite</a> package.\n"
},
"runDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the scheduled payment run is to be executed, in `yyyy-mm-dd hh:mm:ss` format. The backend will ignore mintues and seconds in the field value. For example, if you specify `2017-03-01 11:30:37` for this value, this payment run will be run at 2017-03-01 11:00:00.\n\nYou must specify either the `runDate` field or the `targetDate` field in the request body. If you specify the `runDate` field, the scheduced payment run is to be executed on the run date. If you specify the `targetDate` field, the payment run is executed immediately after it is created. \n"
},
"currency": {
"type": "string",
"description": "A currency defined in the web-based UI administrative settings.\n\nThis field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.\n"
},
"accountId": {
"type": "string",
"format": "uuid",
"description": "The ID of the customer account associated with the payment run.\n\nThis field conflicts with each of the `batch`, `billCycleDay`, `currency`, `paymentGatewayId`, and `billingRunId` fields. If there are such conflicts, an error occurs and an error message is returned.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date used to determine which receivables to be paid in the payment run. The payments are collected for all receivables with the due date no later than the target date.\n\nYou must specify either the `runDate` field or the `targetDate` field in the request body. If you specify the `runDate` field, the scheduced payment run is to be executed on the run date. If you specify the `targetDate` field, the payment run is executed immediately after it is created. \n"
},
"billCycleDay": {
"type": "string",
"description": "The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. The value must be equal to or less then 31, and 31 is mean the EOM.\n\nThis field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.\n"
},
"billingRunId": {
"type": "string",
"format": "uuid",
"description": "The ID of a bill run.\n\nThis field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.\n"
},
"collectPayment": {
"type": "boolean",
"description": "Whether to process electronic payments during the execution of payment runs. \n\nIf the Payment user permission \"Process Electronic Payment\" is disabled, this field will be ignored.\n"
},
"paymentGatewayId": {
"type": "string",
"format": "uuid",
"description": "The ID of the gateway instance that processes the payment.\n\nThis field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.\n"
},
"applyCreditBalance": {
"type": "boolean",
"description": "If `applyCreditBalance` is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.\n"
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organizations that the run is created for. \n\nFor each item in the array, either the `organizationId` or the `organizationName` field is required.\n\nThis field is only required when you have already turned on Multi-Org feature.\n"
},
"autoApplyCreditMemo": {
"type": "boolean",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nWhether to automatically apply a posted credit memo to one or more receivables in the payment run.\n"
},
"consolidatedPayment": {
"type": "boolean",
"description": "**Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information. \n\nWhether to process a single payment for all receivables that are due on an account.\n"
},
"autoApplyUnappliedPayment": {
"type": "boolean",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nWhether to automatically apply unapplied payments to one or more receivables in the payment run.\n"
},
"processPaymentWithClosedPM": {
"type": "boolean",
"description": "**Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information. \n\nWhether to process payments even if the default payment method is closed.\n"
}
}
}
POSTPaymentScheduleRequest
{
"allOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "The amount that needs to be collected by this payment schedule item.\n"
},
"runHour": {
"type": "string",
"description": "At which hour in the day in the tenant’s timezone this payment will be collected. Available values:`[0,1,2,~,22,23]`. If the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time.\nThe default value is `0`.\nIf the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.\n"
},
"currency": {
"type": "string",
"description": "The currency of the payment.\n\n**Note**:\n- This field is optional. If not specified, the default value is the currency set for the account.\n"
},
"description": {
"type": "string",
"description": "Description of the payment schedule item.\n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\nHere is an example:\n```\n\"paymentOption\": [\n {\n \"type\": \"GatewayOptions\",\n \"detail\": {\n \"SecCode\":\"WEB\"\n }\n }\n]\n```\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n\nTo enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/). This field is only available if `zuora-version` is set to `337.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"scheduledDate": {
"type": "string",
"format": "date",
"description": "The date to collect the payment.\n"
},
"billingDocument": {
"type": "object",
"required": [
"type"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the billing document.\n\n**Note:**\nIf a billing document is specified, one of `id` or `number` must be specified. You cannot specify both of them or or skip both.\n"
},
"type": {
"enum": [
"Invoice",
"DebitMemo"
],
"type": "string",
"description": "The type of the billing document. The default value is `Invoice`.\n"
},
"number": {
"type": "string",
"description": "The number of the billing document.\n\n**Note:**\nIf a billing document is specified, one of `id` or `number` must be specified. You cannot specify both of them or skip both.\n"
}
},
"description": "Object for the billing document with which the payment schedule item is associated. \n**Note:** You must specify the same billing document for all the payment schedule items in one payment schedule.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The ID of the payment method.\n\n**Note**:\n- This field is optional. If not specified, the default value is the payment method id set for the account.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "The ID of the payment gateway.\n\n**Note**:\n- This field is optional. If not specified, the default value is the payment gateway id set for the account.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentScheduleItemCustomFields"
}
]
},
"description": "Container array for payment schedule items.\n"
},
"amount": {
"type": "number",
"description": "The amount of each payment schedule item in the payment schedule.\n\n**Note:**\n- This field is required when `items` is not specified.\n- This field will be ignored when `items` is specified.\n- When creating recurring payment schedules, there are 2 options to specify amounts: \n - Specify `totalAmount` and `occurrences`, `amount` will be calculated.\n - Specify `amount` and `occurrences`, `totalAmount` will be calculated.\n You must specify either `totalAmount` or `amount`. Specifying both fields at the same time is not allowed.\n"
},
"period": {
"enum": [
"Monthly",
"Weekly",
"BiWeekly"
],
"type": "string",
"description": "The frequency for the payment collection since the `startDate`.\n\n**Note:**\n- Thie field is required when `items` is not specified.\n- This field will be ignored when `items` is specified.\n- If `startDate` is `30` or `31` and `period` is `Monthly`, when in February, payment schedule will use the last day of February for payment collection. \n"
},
"runHour": {
"type": "integer",
"description": "Specifies at which hour in the day in the tenant’s time zone when this payment will be collected. Available values: `[0,1,2,~,22,23]`.\n\n**Note:**\n- If the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time.\n- If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.\n- This field is optional. The default value is `0`.\n- This field will be ignored when `items` is specified. \n"
},
"currency": {
"type": "string",
"description": "Currency of the payment schedule.\n\n**Note:**\n- This field is optional. The default value is the account's default currency.\n- This field will be ignored when `items` is specified.\n"
},
"accountId": {
"type": "string",
"description": "ID of the customer account the payment schedule belongs to.\n\n**Note:**\n`accountId` and `accountNumber` cannot both be `null`. When both fields are specified, the two values must match each other. \n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The date for the first payment collection.\n\n**Note:**\n- This field is required when `items` is not specified.\n- This field will be ignored when `items` is specified. \n"
},
"prepayment": {
"type": "boolean",
"description": "Indicates whether the payments created by the payment schedule will be used as reserved payments. This field will only be available if the prepaid cash drawdown permission is enabled. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.\n"
},
"standalone": {
"type": "boolean",
"description": "Indicate whether the payments created by the payment schedule are standalone payments or not. When setting to `true`, standalone payments will be created. When setting to `false`, you can either specify a billing document, or not specifying any billing documents. In the later case, unapplied payments will be created. If set to `null`, standalone payment will be created.\n\n**Note**: \n- This field is only available if the Standalone Payment is enabled. Do not include this field if Standalone Payment is not enabled.\n- If Standalone Payment is enabled, default value is `true`.\n"
},
"description": {
"type": "string",
"description": "Description of the payment schedule. Max length is 255.\n"
},
"occurrences": {
"type": "integer",
"description": "The number of payment schedule item to be created. Maximum value is 1000.\n\n**Note:**\n- This field is required when `items` is not specified.\n- This field will be ignored when `items` is specified. \n"
},
"totalAmount": {
"type": "number",
"description": "The total amount of that the payment schedule will collect. This field is only available for recurring payment schedules. \n\n**Note**:\n- When creating recurring payment schedules, there are 2 options to specify amounts:\n \n - Specify `totalAmount` and `occurrences`, `amount` will be calculated.\n - Specify `amount` and `occurrences`, `totalAmount` will be calculated.\n \n You must specify either `totalAmount` or `amount`. Specifying both fields at the same time is not allowed.\n- If the Standalone Payments feature is enabled and `standalone` is set to `true` for the payment schedule, `totalAmount` will be ignored.\n"
},
"accountNumber": {
"type": "string",
"description": "Account number of the customer account the payment schedule belongs to.\n\n**Note:**\n`accountId` and `accountNumber` cannot both be `null`. When both fields are specified, the two values must match each other. \n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\n\nHere is an example:\n```\n\"paymentOption\": [\n {\n \"type\": \"GatewayOptions\",\n \"detail\": {\n \"SecCode\":\"WEB\"\n }\n }\n]\n```\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
},
"billingDocument": {
"type": "object",
"required": [
"type"
],
"properties": {
"id": {
"type": "string",
"description": "ID of the billing document.\n\n**Note:**\n If a billing document is specified, either `id` or `number` of the billing document must be specified. You cannot specify both of them or skip both.\n"
},
"type": {
"enum": [
"Invoice",
"DebitMemo"
],
"type": "string",
"description": "The type of the billing document. The default value is `Invoice`.\n"
},
"number": {
"type": "string",
"description": "ID of the billing document.\n\n**Note:**\n If a billing document is specified, either `id` or `number` of the billing document must be specified. You cannot specify both of them or skip both.\n"
}
},
"description": "Object of the billing document with which the payment schedule is associated.\n\n**Note:**\n- This field is optional. If you have the Standalone Payment feature enabled, you can leave this field blank and set `standalone` to `true` to create standalone payments. You can also choose to create unapplied payments by leaving this object blank and setting `standalone` to `false`.\n- If Standalone Payment is not enabled, leaving this object unspecified will create unapplied payments.\n"
},
"paymentMethodId": {
"type": "string",
"description": "ID of the payment method.\n\n**Note:**\n- This field is optional. The default value is the account's default payment method ID.\n- This field will be ignored when `items` is specified. \n"
},
"paymentGatewayId": {
"type": "string",
"description": "ID of the payment gateway.\n\n**Note:**\n- This field is optional. The default value is the account's default payment gateway ID. If no payment gateway ID is found on the cusotmer account level, the default value will be the tenant's default payment gateway ID.\n- This field will be ignored when `items` is specified.\n"
},
"paymentScheduleNumber": {
"type": "string",
"description": "You can use this field to specify the number of the payment schedule.\nOnly characters from the following sets are allowed: A-Z, a-z, 0-9, and `-`. \nPayment numbers must start with a letter. In addition,`-` can only be used at most once and cannot be placed at the beginning or the end of the payment numbers. \n"
}
}
},
{
"$ref": "#/components/schemas/PaymentScheduleCustomFields"
}
]
}
POSTPaymentScheduleResponse
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the payment schedule.\n"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentScheduleItemCommonResponse"
},
"description": "Container for payment schedule items.\n"
},
"period": {
"type": "string",
"description": "For recurring payment schedule only. The period of payment generation. Available values include: `Monthly`, `Weekly`, `BiWeekly`.\nReturn `null` for custom payment schedules.\n"
},
"status": {
"enum": [
"Active",
"Canceled",
"Completed"
],
"type": "string",
"description": "The status of the payment schedule.\n\n- `Active`: There are still pament schedule items to process.\n- `Canceled`: After a payment schedule is canceled by the user, the schedule is marked as `Canceled`.\n- `Completed`: After all payment schedule items are processed, the schedule is marked as `Completed`.\n"
},
"runHour": {
"type": "integer",
"description": "[0,1,2,~,22,23]\n\nAt which hour in the day in the tenant’s timezone this payment will be collected. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.\nReturn `0` for custom payment schedules.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully. \n"
},
"isCustom": {
"type": "boolean",
"description": "Indicates if the payment schedule is a custom payment schedule.\n"
},
"accountId": {
"type": "string",
"description": "ID of the account that owns the payment schedule.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The date when the first payment of this payment schedule is proccessed.\n"
},
"prepayment": {
"type": "boolean",
"description": "Indicates whether the payments created by the payment schedule are used as a reserved payment. This field will only be available if the prepaid cash drawdown permission is enabled. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.\n"
},
"standalone": {
"type": "boolean",
"description": "Indicates if the payments that the payment schedule created are standalone payments or not.\n"
},
"createdById": {
"type": "string",
"description": "ID of the user who created this payment schedule.\n"
},
"createdDate": {
"type": "string",
"format": "date",
"description": "The date and time the payment schedule is created.\n"
},
"description": {
"type": "string",
"description": "The description of the payment schedule.\n"
},
"occurrences": {
"type": "integer",
"description": "The number of payment schedule items that are created by this payment schedule.\n"
},
"totalAmount": {
"type": "number",
"description": "The total amount that will be collected by this payment schedule. This field will contain a null value if the `standalone` value is `true`.\n"
},
"updatedById": {
"type": "string",
"description": "ID of the user who last updated this payment schedule.\n"
},
"updatedDate": {
"type": "string",
"format": "date",
"description": "The date and time the payment schedule is last updated.\n"
},
"accountNumber": {
"type": "string",
"description": "Number of the account that owns the payment schedule.\n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
},
"billingDocument": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.\n"
},
"type": {
"type": "string",
"description": "Indicates whether the associated billing document is a debit memo or a invoice.\n"
},
"number": {
"type": "string",
"description": "Number of the billing docuemnt, for example, `INV00002345`.\n"
}
}
},
"nextPaymentDate": {
"type": "string",
"format": "date",
"description": "The date the next payment will be processed.\n"
},
"recentPaymentDate": {
"type": "string",
"format": "date",
"description": "The date the last payment was processed.\n"
},
"totalPaymentsErrored": {
"type": "integer",
"description": "The number of errored payments.\n"
},
"paymentScheduleNumber": {
"type": "string",
"description": "Number of the payment schedule.\n"
},
"totalPaymentsProcessed": {
"type": "integer",
"description": "The number of processed payments.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentScheduleCustomFields"
}
]
}
POSTPaymentSchedulesEach
{
"type": "object",
"title": "Payment Schedule ID and Number",
"properties": {
"id": {
"type": "string",
"description": "The ID of the created payment schedule.\n"
},
"paymentScheduleNumber": {
"type": "string",
"description": "The number of the created payment schedule.\n"
}
}
}
POSTPaymentSchedulesRequest
{
"type": "object",
"properties": {
"paymentSchedules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTPaymentScheduleRequest"
},
"description": "Container of the payment schedules to be created.\n"
}
}
}
POSTPaymentSchedulesResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"paymentSchedules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTPaymentSchedulesEach"
},
"description": "Container for payment parts.\n"
}
},
"description": "Container of the payment schedules that are created.\n"
}
POSTPreviewBillingAdjustmentRequestType
{
"type": "object",
"example": {
"type": "DeliveryCredit",
"reason": "string",
"endDate": "2023-02-27",
"exclusion": [
{
"deliveryDate": "2023-02-26",
"chargeNumbers": [
"string",
"string"
]
},
{
"deliveryDate": "2023-05-27",
"chargeNumbers": [
"string",
"string"
]
}
],
"startDate": "2023-02-26",
"chargeNumbers": [
"string",
"string"
],
"subscriptionNumber": "string",
"revenueRecognitionRuleName": "string",
"deferredRevenueAccountingCode": "string",
"recognizedRevenueAccountingCode": "string"
},
"required": [
"startDate",
"endDate"
],
"properties": {
"type": {
"enum": [
"DeliveryCredit"
],
"type": "string",
"description": "The type of delivery adjustment.\n"
},
"reason": {
"type": "string",
"description": "The reason for the delivery adjustment.\n"
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive.\n"
},
"accountNumber": {
"type": "string",
"description": "The account number for which the delivery adjustment is created.\n**Note**: \n - The account number should be of the subscription owner.\n - Only one of accountNumber or subscriptionNumber should be provided.\n"
},
"chargeNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "An optional container to specify charge numbers in the subscription for which the delivery adjustment needs to be created.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "The subscription number for which the delivery adjustment is created.\n\n**Note**: Only one of accountNumber or subscriptionNumber should be provided.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n\n**Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n\n**Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n\n**Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge.\n"
}
}
}
POSTProductChargeDefinitionPricing
{
"type": "object",
"title": "prices",
"properties": {
"price": {
"type": "number",
"description": "The price of this item. \n\nThis field is only applicable for charges based on the following charge models:\n - Flat Fee\n - Per Unit\n - Delivery Pricing\n"
},
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTChargeDefinitionPricingTier"
},
"description": "Container for the tiers of the price item. \n\nThis field is only applicable for charges based on the following charge models:\n - Tiered Pricing\n - Volume Pricing\n\nYou must specify all relevant fields of all tiers, including pricing information for each currency.\nFor each currency, ensure that the tiers appear in ascending order of `StartingUnit`.\n\nFor example:\n\n```\n[\n {\n \"startingUnit\": \"1\",\n \"endingUnit\": \"150\",\n \"currency\": \"USD\",\n \"price\": 1.95,\n \"priceFormat\": \"Per Unit\"\n },\n {\n \"startingUnit\": \"151\",\n \"endingUnit\": \"300\",\n \"currency\": \"USD\",\n \"price\": 1.45,\n \"priceFormat\": \"Per Unit\"\n },\n {\n \"startingUnit\": \"1\",\n \"endingUnit\": \"150\",\n \"currency\": \"EUR\",\n \"price\": 1.75,\n \"priceFormat\": \"Per Unit\"\n },\n {\n \"startingUnit\": \"151\",\n \"endingUnit\": \"300\",\n \"currency\": \"EUR\",\n \"price\": 1.30,\n \"priceFormat\": \"Per Unit\"\n }\n]\n``` \n"
},
"currency": {
"type": "string",
"description": "The currency for the price.\n"
},
"discountAmount": {
"type": "number",
"format": "double",
"description": "The specific amount for a fixed discount. The field is applicable only for charges based on the Discount-Fixed Amount charge model.\n"
},
"discountPercentage": {
"type": "number",
"format": "double",
"description": "The percentage of discount for a percentage discount. The field is applicable only for charges based on the Discount-Percentage charge model.\n"
}
}
}
POSTPublicEmailTemplateRequest
{
"type": "object",
"example": {
"name": "Account Edit Email",
"active": true,
"isHtml": true,
"fromName": "Example Co. Ltd.",
"emailBody": "Dear user,<p>the account <Account.Name> has been edited. <p>Example Co. Ltd.",
"ccEmailType": "SpecificEmails",
"description": "Email when an account is edited",
"toEmailType": "BillToContact",
"emailHeaders": {
"My-Header-1": "Header value 1",
"My-Header-2": "Header value 2"
},
"emailSubject": "Account <Account.Number> has been edited",
"encodingType": "UTF8",
"eventTypeName": "AccountEdit",
"fromEmailType": "TenantEmail",
"ccEmailAddress": "user@example.com",
"toEmailAddress": null,
"bccEmailAddress": "user@example.com",
"fromEmailAddress": null,
"replyToEmailType": "TenantEmail",
"replyToEmailAddress": null
},
"required": [
"name",
"fromEmailType",
"emailSubject",
"emailBody",
"toEmailType"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the email template, a unique name in a tenant."
},
"active": {
"type": "boolean",
"default": true,
"description": "The status of the email template. The default value is `true`."
},
"isHtml": {
"type": "boolean",
"default": false,
"description": "Indicates whether the style of email body is HTML. The default value is `false`."
},
"fromName": {
"type": "string",
"description": "The name of the email sender."
},
"emailBody": {
"type": "string",
"description": "The email body. You can add merge fields in the email body using angle brackets or double curly brackets. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates\" target=\"_blank\">Merge field syntax for email templates</a>.\n\nYou can also embed HTML tags if `isHtml` is `true`.\n"
},
"ccEmailType": {
"enum": [
"BillToContact",
"SoldToContact",
"SpecificEmails",
"TenantAdmin",
"BillToAndSoldToContacts",
"RunOwner",
"AllContacts",
"InvoiceOwnerBillToContact",
"InvoiceOwnerSoldToContact",
"InvoiceOwnerBillToAndSoldToContacts",
"InvoiceOwnerAllContacts"
],
"type": "string",
"default": "SpecificEmails",
"description": "Email CC type.\n* When the base object for the event is associated with `Account`, `ccEmailType` can be any values in the enum list. \n* When the base object for the event is not associated with `Account`, `ccEmailType` must be `TenantAdmin`, `RunOwner`, or `SpecificEmail`. "
},
"description": {
"type": "string",
"maxLength": 255,
"description": "The description of the email template."
},
"toEmailType": {
"enum": [
"BillToContact",
"SoldToContact",
"SpecificEmails",
"TenantAdmin",
"BillToAndSoldToContacts",
"RunOwner",
"AllContacts",
"InvoiceOwnerBillToContact",
"InvoiceOwnerSoldToContact",
"InvoiceOwnerBillToAndSoldToContacts",
"InvoiceOwnerAllContacts"
],
"type": "string",
"description": "Email receive type.\n* When the base object for the event is associated with `Account`, `toEmailType` can be any values in the enum list. \n* When the base object for the event is not associated with `Account`, `toEmailType` must be `TenantAdmin`, `RunOwner`, or `SpecificEmail`. "
},
"emailHeaders": {
"type": "object",
"title": "emailHeader",
"description": "Container for custom email headers. Each custom email header consists of a header name and a header value.\n",
"additionalProperties": {
"type": "string",
"description": "The custom email header consists of a name-value pair:\n\n* Field name: the name of the custom email header.\n\n* Field value: the value of the custom email header. You can add merge fields in the field value. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates\" target=\"_blank\">Merge field syntax for email templates</a>.\n"
}
},
"emailSubject": {
"type": "string",
"description": "The email subject. You can add merge fields in the email subject using angle brackets or double curly brackets. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates\" target=\"_blank\">Merge field syntax for email templates</a>.\n"
},
"encodingType": {
"enum": [
"UTF8",
"Shift_JIS",
"ISO_2022_JP",
"EUC_JP",
"X_SJIS_0213"
],
"type": "string",
"default": "UTF8",
"description": "The endcode type of the email body."
},
"eventCategory": {
"type": "number",
"description": "If you specify this 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"
},
"eventTypeName": {
"type": "string",
"description": "The name of the custom event or custom scheduled event. If you specify this field, the email template is created based on the corresponding custom event or custom scheduled event.\n"
},
"fromEmailType": {
"enum": [
"TenantEmail",
"RunOwner",
"SpecificEmail"
],
"type": "string",
"description": "The type of the email."
},
"ccEmailAddress": {
"type": "string",
"description": "The email CC address."
},
"toEmailAddress": {
"type": "string",
"description": "If toEmailType is SpecificEmail, this field is required."
},
"bccEmailAddress": {
"type": "string",
"format": "email",
"description": "The email bcc address."
},
"fromEmailAddress": {
"type": "string",
"description": "If fromEmailType is SpecificEmail, this field is required."
},
"replyToEmailType": {
"enum": [
"TenantEmail",
"RunOwner",
"SpecificEmail"
],
"type": "string",
"description": "Type of the replyTo email."
},
"eventTypeNamespace": {
"type": "string",
"description": "The namespace of the `eventTypeName` field. The `eventTypeName` has the `user.notification` namespace by default. \n\nNote that if the `eventTypeName` is a standard event type, you must specify the `com.zuora.notification` namespace; otherwise, you will get an error.\n\nFor example, if you want to create an email template on the `OrderActionProcessed` event, you must specify `com.zuora.notification` for this field. \n"
},
"replyToEmailAddress": {
"type": "string",
"description": "If replyToEmailType is SpecificEmail, this field is required."
}
}
}
POSTPublicNotificationDefinitionCalloutBasicAuthentication
{
"allOf": [
{
"$ref": "#/components/schemas/POSTPublicNotificationDefinitionCalloutCommon"
},
{
"type": "object",
"required": [
"requiredAuth"
],
"properties": {
"calloutAuth": {
"$ref": "#/components/schemas/CalloutAuth"
},
"requiredAuth": {
"type": "boolean",
"description": "Indicates whether Basic authentication is enabled for the callout.\n\nWhen creating callout notifications with Basic authentication enabled, you must set this field to `true` and specify the username and password in `calloutAuth`.\n"
}
},
"description": "The Basic Authentication information for callout notifications.\n"
}
],
"title": "Callout - Base authentication"
}
POSTPublicNotificationDefinitionCalloutCommon
{
"type": "object",
"title": "Callout - without authentication",
"required": [
"name",
"calloutBaseurl",
"httpMethod"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the created callout."
},
"active": {
"type": "boolean",
"default": true,
"description": "The status of the callout. The default is `true`."
},
"httpMethod": {
"enum": [
"GET",
"PUT",
"POST",
"DELETE"
],
"type": "string",
"example": "POST",
"description": "The HTTP method of the callout."
},
"description": {
"type": "string",
"maxLength": 255,
"description": "Description for the callout."
},
"calloutRetry": {
"type": "boolean",
"default": true,
"description": "Specified whether to retry the callout when the callout fails. The default value is `true`."
},
"calloutParams": {
"$ref": "#/components/schemas/CalloutMergeFields"
},
"eventTypeName": {
"type": "string",
"minLength": 1,
"description": "The name of the event type. The value must be the same as the parent-level `eventTypeName` field."
},
"calloutBaseurl": {
"type": "string",
"format": "url",
"example": "https://***",
"minLength": 10,
"description": "The callout URL. It must start with 'https://'"
}
},
"description": "Common information for callout notifications.\n"
}
POSTPublicNotificationDefinitionCalloutOauth2Authentication
{
"allOf": [
{
"$ref": "#/components/schemas/POSTPublicNotificationDefinitionCalloutCommon"
},
{
"type": "object",
"required": [
"requiredOauth2"
],
"properties": {
"requiredOauth2": {
"type": "boolean",
"description": "Indicates whether OAuth 2.0 authentication is enabled for the callout.\n\nWhen creating callout notifications with OAuth 2.0 authentication enabled, you must set this field to `true` and specify the OAuth 2.0 provider ID in `oauth2ProviderId`.\n"
},
"oauth2ProviderId": {
"description": "The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout. This field is required if `requiredOauth2` is `true`.\n\nFor more information about how to get the ID of an OAuth 2.0 provider, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/Add_an_OAuth_2.0_Provider#Retrieve_the_ID_of_an_OAuth_2.0_provider\" target=\"_blank\">Retrieve the ID of an OAuth 2.0 provider</a>.\n"
}
},
"description": "The OAuth 2.0 Authentication information for callout notifications.\n"
}
],
"title": "Callout - OAuth 2.0 authentication"
}
POSTPublicNotificationDefinitionRequest
{
"type": "object",
"example": {
"name": "Account Edit Notification",
"active": true,
"callout": {
"name": "Callout for Account Edited",
"active": true,
"httpMethod": "POST",
"calloutAuth": {
"domain": "example_domain",
"password": "example_password",
"username": "example_user",
"preemptive": true
},
"description": "Callout when an account is edited",
"calloutRetry": true,
"requiredAuth": true,
"calloutParams": {
"AccountName": "<Account.Name>",
"AccountNumber": "<Account.AccountNumber>"
},
"eventTypeName": "AccountEdit",
"calloutBaseurl": "https://www.example.com/callout/AccountEdit"
},
"filterRule": {
"condition": "Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS",
"parameters": {
"_ACCOUNT_STATUS": {
"options": [
"Draft",
"Active",
"Canceled"
],
"valueType": "STRING",
"description": "The status of the VIP Account",
"displayName": "VIP Account Status"
},
"_VIP_BALANCE_AMOUNT": {
"options": null,
"valueType": "BIG_DECIMAL",
"description": "The minimum account balance",
"displayName": "VIP Account Balance"
}
},
"description": "Filter rule to test if an account is a VIP account"
},
"description": "Notification sent out when an account is edited",
"emailActive": true,
"calloutActive": true,
"eventTypeName": "AccountEdit",
"emailTemplateId": "6e569e1e05f040eda51a927b140c0ac6",
"filterRuleParams": {
"_ACCOUNT_STATUS": "Active",
"_VIP_BALANCE_AMOUNT": "100000"
},
"associatedAccount": "ParentAccount.Id",
"communicationProfileId": "6e569e1e05f040eda51a927b140c0ac5"
},
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the notification definition, unique per communication profile."
},
"active": {
"type": "boolean",
"default": true,
"description": "The status of the notification definition. The default value is `true`."
},
"callout": {
"oneOf": [
{
"$ref": "#/components/schemas/POSTPublicNotificationDefinitionCalloutCommon"
},
{
"$ref": "#/components/schemas/POSTPublicNotificationDefinitionCalloutBasicAuthentication"
},
{
"$ref": "#/components/schemas/POSTPublicNotificationDefinitionCalloutOauth2Authentication"
}
]
},
"filterRule": {
"type": "object",
"required": [
"condition",
"parameters"
],
"properties": {
"condition": {
"type": "string",
"example": "Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS",
"description": "The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/).\nThe rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to filter an invoice posted notification to only invoices with an amount over 1000, you would define the following condition:\n\n```Invoice.Amount > 1000```\n\nThere are conventions and keywords you need to be aware of. For example:\n\n* `Invoice.Amount` refers to the `Amount` field of the Zuora object `Invoice`.\n\n* Unlike Event Triggers, there is no access to variables with the `_old` suffix. Fields with the `_old` suffix are only available on Event Trigger conditions.\n"
},
"parameters": {
"$ref": "#/components/schemas/FilterRuleParameterDefinitions"
},
"description": {
"type": "string",
"maxLength": 255,
"description": "The description of the filter rule."
}
},
"description": ""
},
"description": {
"type": "string",
"maxLength": 255,
"description": "The description of the notification definition."
},
"emailActive": {
"type": "boolean",
"default": false,
"description": "The status of the email action. The default value is `false`."
},
"calloutActive": {
"type": "boolean",
"default": false,
"description": "The status of the callout action. The default value is `false`."
},
"eventCategory": {
"type": "number",
"description": "The event category code for a standard event, on which the notification definition is created.\n\nThis field is required when creating notification definitions for standard events.\n\nFor the list of supported standard event category codes, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Events_and_Notifications\" target=\"_blank\">Standard event category code for events and notifications</a>.\n"
},
"eventTypeName": {
"type": "string",
"minLength": 1,
"description": "The name of the event that the notification definition is based on.\n\nThis field is required when creating notification definitions for Zuora custom events, custom events, or custom scheduled events.\n\nIf this field is provided, you can specify the event namespace in the `eventTypeNamespace` field. \n"
},
"emailTemplateId": {
"type": "string",
"format": "uuid",
"description": "The ID of the email template. If `emailActive` is `true`, an email template is required. And EventType of the email template MUST be the same as the eventType."
},
"filterRuleParams": {
"$ref": "#/components/schemas/FilterRuleParameterValues"
},
"associatedAccount": {
"type": "string",
"description": "The account on which the histories of this notification will be displayed. The associated account does not enforce where the merge fields come from.\nAvailable values are as follows:\n* `Account.Id`: ID of the primary customer account related to the notification. It is also the default value.\n* `ParentAccount.Id`: this option is available only if you have <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\" target=\"_blank\">Customer Hierarchy</a> enabled for your tenant.\n* `SubscriptionOwnerAccount.Id`: this option is available if the base object of the notification is Order Action.\n\n**Note:** before specifying this field, we recommend that you use [Data Source](https://knowledgecenter.zuora.com/Billing/Reporting/D_Data_Sources_and_Exports/C_Data_Source_Reference) to check the available types of accounts for the current notification. \n"
},
"eventTypeNamespace": {
"enum": [
"user.notification",
"com.zuora.notification"
],
"type": "string",
"default": "user.notification",
"description": "The namespace of the `eventTypeName` field. It indicates who created the event and which namespace the event is assigned to.\n\nSupported values are as follows:\n\n- `com.zuora.notification`: events that are created by Zuora. This value applies to Zuora custom events.\n- `user.notification`: events that are created by tenant users. This value applies to custom events and custom scheduled events. This is the default value. \n \nFor example, if you want to create a notification definition on the `OrderActionProcessed` event, which is a Zuora custom event, you must specify `com.zuora.notification` for this field.\n"
},
"communicationProfileId": {
"type": "string",
"description": "The profile that notification definition belongs to. \n\nYou can use the [Query Action](https://developer.zuora.com/api-references/api/operation/Action_POSTquery) to get the communication profile Id. See the following request sample:\n\n`{\n \"queryString\": \"select Id, ProfileName from CommunicationProfile\"\n }`\n\nIf you do not pass the communicationProfileId, notification service will be automatically added to the 'Default Profile'.\n"
}
}
}
POSTRSASignatureResponseType
{
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Public key generated for this Payment Page.\n"
},
"token": {
"type": "string",
"description": "Token generated for this Payment Page.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"tenantId": {
"type": "string",
"description": "ID of the Zuora tenant.\n"
},
"signature": {
"type": "string",
"description": "Digital signature generated for this Payment Page.\n\nIf `signature` returns `null` but `token` is successfully returned, please limit the number of the fields in your request to make sure that the maximum length supported by the RSA signature algorithm is not exceeded.\n"
}
}
}
POSTRSASignatureType
{
"type": "object",
"example": {
"uri": "https://apisandbox.zuora.com/apps/PublicHostedPageLite.do",
"method": "POST",
"pageId": "2c92c0f855e2b4630155ec9e6a1b6eec",
"currency": "USD"
},
"required": [
"method",
"pageId",
"uri"
],
"properties": {
"id": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"key": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"uri": {
"type": "string",
"description": "The URL that the Payment Page will be served from.\n* For US Cloud 1 Production environment: Use https://na.zuora.com/apps/PublicHostedPageLite.do\n* For US Cloud 1 Sandbox environment: Use https://sandbox.na.zuora.com/apps/PublicHostedPageLite.do\n* For US Cloud 2 Production environment: Use https://www.zuora.com/apps/PublicHostedPageLite.do\n* For US Cloud 2 API Sandbox environment: Use https://apisandbox.zuora.com/apps/PublicHostedPageLite.do\n* For US Central Sandbox environment: Use https://test.zuora.com/apps/PublicHostedPageLite.do\n* For EU Cloud Production environment: Use https://eu.zuora.com/apps/PublicHostedPageLite.do\n* For EU Cloud Sandbox environment: Use https://sandbox.eu.zuora.com/apps/PublicHostedPageLite.do\n* For EU Central Sandbox environment: Use https://test.eu.zuora.com/apps/PublicHostedPageLite.do\n"
},
"IBAN": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"pmId": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters specific for credit cards. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"style": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"token": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"locale": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"method": {
"type": "string",
"description": "The type of the request. Set it to POST.\n"
},
"pageId": {
"type": "string",
"description": "The page id of your Payment Pages 2.0 form. Click **Show Page Id** next to the Payment Page name in the Hosted Page List to retrieve the page id.\n"
},
"bankCity": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"currency": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"tenantId": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"accountId": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"signature": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"gatewayName": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"cityBlackList": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters specific for credit cards. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"cityWhiteList": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters specific for credit cards. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"signatureType": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"submitEnabled": {
"type": "boolean",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"bankBranchCode": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"bankCheckDigit": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"bankPostalCode": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"bankStreetName": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"paymentGateway": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"deviceSessionId": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"bankStreetNumber": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"paymentRetryWindow": {
"type": "integer",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"authorizationAmount": {
"type": "number",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"useDefaultRetryRule": {
"type": "boolean",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"param_supportedTypes": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters specific for credit cards. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"passthrough[1,2,3,4,5]": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n\nNote: Although up to 15 passthrough parameters can be supported when passing in your client parameters, only the first 5 parameters are used for signature generation and validation.\n"
},
"businessIdentificationCode": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters specific for Bank Transfer - Direct Debit. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"param_gwOptions_[*option*]": {
"type": "string",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
},
"maxConsecutivePaymentFailures": {
"type": "integer",
"description": "An optional client parameter that can be used for validating client-side HPM parameters. \nSee [Client parameters for Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) \nand [Validate client-side HPM parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) \nfor details.\n"
}
}
}
POSTRatePlanDefinitionRequest
{
"type": "object",
"example": {
"productRatePlanId": "2c9890678b1ca909018b1caea5c30000",
"productRatePlanNumber": "PRP-00000008",
"productRatePlanChargeId": "2c9890e489f227bd0189f22f3482001f",
"productRatePlanChargeNumber": "PRPC-00000001"
},
"properties": {
"productRatePlanId": {
"type": "string",
"description": "The unique ID of the product rate plan that uses this rate plan definition.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "The unique number (natural key) of the product rate plan that uses this rate plan definition.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The unique ID of the product rate plan charge to be used in the product rate plan.\n"
},
"productRatePlanChargeNumber": {
"type": "string",
"description": "The unique number (natural key) of the product rate plan charge to be used in the product rate plan.\n"
}
}
}
POSTRatePlanDefinitionResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the product charge definition.\n"
},
"success": {
"type": "boolean",
"description": "Indicates whether the request succeeded.\n"
}
}
}
POSTReconcileRefundRequest
{
"type": "object",
"example": {
"action": "settle",
"payoutId": "PAYOUT123",
"actionDate": "2020-10-25 11:11:11",
"gatewayReconciliationReason": "refund_paid",
"gatewayReconciliationStatus": "paid"
},
"properties": {
"action": {
"enum": [
"settle",
"reject"
],
"type": "string",
"description": "The action of the refund reconciliation.\n - `settle`: Sets Gateway State to \"Settled\" and returns the refund object as response.\n - `reject`: Sets Gateway State to \"FailedToSettle\" and handle the event according to the settings configured in the Gateway Reconciliation Configuration in Payments Settings through Zuora UI. See [Configure how to handle refund rejected events](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Gateway_Reconciliation#Configure_how_to_handle_refund_rejected_events) for details.\n"
},
"payoutId": {
"type": "string",
"description": "The payout ID of the refund from the gateway side.\n"
},
"actionDate": {
"type": "string",
"format": "datetime",
"description": "The date and time of the refund reconciliation action, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
}
POSTReconcileRefundResponse
{
"type": "object",
"example": {
"id": "4028905f5a87c0ff015a889e590e00c9X",
"type": "Electronic",
"amount": 4,
"number": "R-00000001",
"status": "Processed",
"comment": "Create a refund for unapplied payment.",
"success": true,
"payoutId": "PAYOUT123",
"accountId": "4028905f5a87c0ff015a87d25ae90025",
"gatewayId": null,
"paymentId": "4028905f5a87c0ff015a889ddfb800c0",
"settledOn": "2020-10-25 11:11:11",
"methodType": "CreditCard",
"reasonCode": "Standard Refund",
"refundDate": "2020-03-01",
"cancelledOn": null,
"createdById": "402881e522cf4f9b0122cf5d82860002",
"createdDate": "2020-03-01 14:46:03",
"referenceId": null,
"submittedOn": null,
"updatedById": "402881e522cf4f9b0122cf5d82860002",
"updatedDate": "2020-03-01 14:46:03",
"creditMemoId": null,
"gatewayState": "Settled",
"softDescriptor": null,
"gatewayResponse": null,
"paymentMethodId": null,
"financeInformation": {
"transferredToAccounting": "No",
"bankAccountAccountingCode": null,
"bankAccountAccountingCodeType": null,
"unappliedPaymentAccountingCode": null,
"unappliedPaymentAccountingCodeType": null
},
"gatewayResponseCode": null,
"softDescriptorPhone": null,
"markedForSubmissionOn": null,
"refundTransactionTime": null,
"paymentMethodSnapshotId": null,
"secondRefundReferenceId": null,
"gatewayReconciliationReason": "refund_paid",
"gatewayReconciliationStatus": "paid"
},
"properties": {
"id": {
"type": "string",
"description": "The ID of the refund.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the refund.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the refund.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the refund. For example, R-00000001.\n"
},
"status": {
"type": "string",
"description": "The status of the refund.\n"
},
"comment": {
"type": "string",
"description": "Comments about the refund.\n"
},
"success": {
"type": "boolean",
"description": "Indicates if the request is processed successfully.\n"
},
"payoutId": {
"type": "string",
"description": "The payout ID of the refund from the gateway side.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account that the refund is for.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the refund.\n"
},
"paymentId": {
"type": "string",
"description": "The ID of the payment that is refunded.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the transaction is settled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"methodType": {
"enum": [
"ACH",
"Cash",
"Check",
"CreditCard",
"PayPal",
"WireTransfer",
"DebitCard",
"CreditCardReferenceTransaction",
"BankTransfer",
"Other"
],
"type": "string",
"description": "How an external refund was issued to a customer. \n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. \n"
},
"refundDate": {
"type": "string",
"format": "date",
"description": "The date when the refund takes effect, in `yyyy-mm-dd` format. For example, 2020-03-01. \n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the transaction was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the refund.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund is created, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was submitted, in yyyy-mm-dd hh:mm:ss format.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the refund.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was last updated, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo that is refunded.\n"
},
"gatewayState": {
"enum": [
"Settled",
"FailedToSettle"
],
"type": "string",
"description": "The status of the refund in the gateway; specifically used for reconciliation.\n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the refund. This message is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the refund.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"bankAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to a bank account in your accounting system.\n \n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the unapplied payment.\n"
},
"unappliedPaymentAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the unapplied payment.\n \n"
}
},
"description": "Container for the finance information related to the refund.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the refund. This code is gateway-dependent.\n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways. \n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"refundTransactionTime": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n"
},
"secondRefundReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional refund. \n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
}
POSTRegisterApplePayDomainRequest
{
"type": "object",
"example": {
"domainName": "testapplepay.zuora.com"
},
"required": [
"domainName"
],
"properties": {
"domainName": {
"type": "string",
"description": "The name of the domain to be registered with Apple Pay, such as `testapplepay.zuora.com`.\n"
}
}
}
POSTRegisterApplePayDomainResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the domain, such as `402881a38924ff1001892502da090021`.\n"
},
"success": {
"type": "boolean",
"description": "Indicates whether this call succeeds.\n"
},
"domainName": {
"type": "string",
"description": "The name of the domain registered with Apple Pay, such as `testapplepay.zuora.com`.\n"
},
"domainVerified": {
"type": "boolean",
"description": "Indicates whether the domain registration is successfully verified.\n"
}
}
}
POSTRejectPaymentRequest
{
"type": "object",
"example": {
"settledOn": "2019-05-07 20:56:32.981",
"referenceId": "825522036728874689",
"gatewayResponse": "Insufficient funds",
"secondReferenceId": "825522036690700110",
"gatewayResponseCode": "023",
"gatewayReconciliationReason": "insufficient_funds",
"gatewayReconciliationStatus": "payment_failed"
},
"properties": {
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time of the transaction settlement. The format is `yyyy-mm-dd hh:mm:ss`.\n"
},
"referenceId": {
"type": "string",
"maxLength": 100,
"description": "Unique Id generated by the gateway for each transaction. Use this ID to find the respective Zuora Payment ID. \n"
},
"gatewayResponse": {
"type": "string",
"description": "The transaction response returned by the gateway for this transaction. If the transaction was declined, this reason is provided in the message.\n"
},
"secondReferenceId": {
"type": "string",
"maxLength": 100,
"description": "The second reference Id. Some gateway uses two unique transaction IDs.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "Response message Code returned by the gateway about the transaction status.\n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
}
POSTRejectPaymentResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the payment chargeback.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the payment.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the payment. For example, P-00000001.\n"
},
"status": {
"type": "string",
"description": "The status of the payment.\n"
},
"comment": {
"type": "string",
"description": "Comments about the payment.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"payoutId": {
"type": "string",
"description": "The payout ID from the gateway side.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account that the payment is for.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the payment.\n"
},
"paymentId": {
"type": "string",
"description": "The ID of the payment that is refunded.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the transaction is settled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"methodType": {
"enum": [
"ACH",
"Cash",
"Check",
"CreditCard",
"PayPal",
"WireTransfer",
"DebitCard",
"CreditCardReferenceTransaction",
"BankTransfer",
"Other"
],
"type": "string",
"description": "How an external refund was issued to a customer. \n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. \n"
},
"refundDate": {
"type": "string",
"format": "date",
"description": "The date when the refund takes effect, in `yyyy-mm-dd` format. For example, 2017-03-01. \n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the refund.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the chargeback is created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2019-03-01 15:31:10.\n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was submitted, in yyyy-mm-dd hh:mm:ss format.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the payment.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2019-03-02 15:36:10.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo that is refunded.\n"
},
"gatewayState": {
"enum": [
"Submitted",
"NotSubmitted",
"Settled",
"FailedToSettle"
],
"type": "string",
"description": "The status of the payment in the gateway; specifically used for reconciliation.\n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the payment. This message is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the payment.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"bankAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to a bank account in your accounting system.\n \n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the unapplied payment.\n"
},
"unappliedPaymentAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the unapplied payment.\n \n"
}
},
"description": "Container for the finance information related to the refund.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the payment. This code is gateway-dependent.\n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways. \n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a charge was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"refundTransactionTime": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n"
},
"secondRefundReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional refund. \n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
}
POSTResendCalloutNotifications
{
"type": "array",
"items": {
"type": "string",
"description": "ID for failed callout notifications. You can resend at most 1000 callout notifications at a time.\n"
},
"example": [
"a02ea6d76931475bb73fcd339b5f6ht8g",
"40dbbc5f2cfb4e2fa236db11ea1dfghht",
"a3fd8e81c20a4ac0a1eb3747339asdfef",
"a00000000000000000000000000000000"
]
}
POSTResendEmailNotifications
{
"type": "array",
"items": {
"type": "string",
"description": "ID for failed email notifications. You can resend at most 1000 email notifications at a time.\n"
},
"example": [
"a02ea6d76931475bb73fcd339b5f6ht8g",
"40dbbc5f2cfb4e2fa236db11ea1dfghht",
"a3fd8e81c20a4ac0a1eb3747339asdfef",
"a00000000000000000000000000000000"
]
}
POSTRetryPaymentScheduleItemInfo
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Specifies the ID of the payment schedule item to be retried.\n"
},
"paymentMethodId": {
"type": "string",
"description": "Specifies the ID of a payment method that will be used in the retry.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "Specifies the ID of a payment gateway that will be used in the retry.\n"
}
},
"description": "Information of the payment schedule items to be retried.\n"
}
POSTRetryPaymentScheduleItemRequest
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTRetryPaymentScheduleItemInfo"
},
"title": "Payment schedule items to be retried.",
"description": "The maximum number of items allowable to pass is 10.\n"
}
}
}
POSTRetryPaymentScheduleItemResponse
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentScheduleItemCommonResponse"
}
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully. \n"
}
}
}
POSTReversePaymentRequest
{
"type": "object",
"example": {
"amount": 100,
"payoutId": "PAYOUT123",
"settledOn": "2019-05-07 20:56:32.981",
"referenceId": "825522036728874689",
"gatewayResponse": "Insufficient funds",
"secondReferenceId": "825522036690700110",
"gatewayResponseCode": "023",
"gatewayReconciliationReason": "insufficient_funds",
"gatewayReconciliationStatus": "payment_failed"
},
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"description": "The amount that needs to be reversed (chargeback). It cannot be greater than the total Payment amount. \n"
},
"payoutId": {
"type": "string",
"description": "The payout ID from the gateway side.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time of the transaction settlement. The format is `yyyy-mm-dd hh:mm:ss`.\n"
},
"referenceId": {
"type": "string",
"maxLength": 100,
"description": "Unique Id generated by the gateway for each transaction. Use this ID to find the respective Zuora Payment ID. \n"
},
"gatewayResponse": {
"type": "string",
"description": "The transaction response returned by the gateway for this transaction. If the transaction was declined, this reason is provided in the message.\n"
},
"secondReferenceId": {
"type": "string",
"maxLength": 100,
"description": "The second reference Id. Some gateways use two unique transaction IDs.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "Response message Code returned by the gateway about the transaction status.\n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
}
POSTReversePaymentResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the payment chargeback.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the payment.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the payment. For example, P-00000001.\n"
},
"status": {
"type": "string",
"description": "The status of the payment.\n"
},
"comment": {
"type": "string",
"description": "Comments about the payment.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"payoutId": {
"type": "string",
"description": "The payout ID from the gateway side.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account that the payment is for.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the payment.\n"
},
"paymentId": {
"type": "string",
"description": "The ID of the payment that is refunded.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the transaction is settled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"methodType": {
"enum": [
"ACH",
"Cash",
"Check",
"CreditCard",
"PayPal",
"WireTransfer",
"DebitCard",
"CreditCardReferenceTransaction",
"BankTransfer",
"Other"
],
"type": "string",
"description": "How an external refund was issued to a customer. \n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. \n"
},
"refundDate": {
"type": "string",
"format": "date",
"description": "The date when the refund takes effect, in `yyyy-mm-dd` format. For example, 2017-03-01.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the refund.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the chargeback is created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2019-03-01 15:31:10.\n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was submitted, in yyyy-mm-dd hh:mm:ss format.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the payment.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2019-03-02 15:36:10.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo that is refunded.\n"
},
"gatewayState": {
"enum": [
"Submitted",
"NotSubmitted",
"Settled",
"FailedToSettle"
],
"type": "string",
"description": "The status of the payment in the gateway; specifically used for reconciliation.\n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the payment. This message is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the payment.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"bankAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to a bank account in your accounting system.\n \n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the unapplied payment.\n"
},
"unappliedPaymentAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the unapplied payment.\n \n"
}
},
"description": "Container for the finance information related to the refund.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the payment. This code is gateway-dependent.\n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways. \n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a charge was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"refundTransactionTime": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n"
},
"secondRefundReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional refund. \n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
}
POSTReverseRolloverRequestType
{
"allOf": [
{
"type": "object",
"required": [
"subscriptionNumber",
"prepaymentUom",
"sourceValidityPeriod",
"destinationValidityPeriod"
],
"properties": {
"prepaymentUom": {
"type": "string",
"description": "Specifies the units of measure for prepayment charge. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**.\n\n**Values**: a valid unit of measure\n"
},
"subscriptionNumber": {
"type": "string",
"maxLength": 100,
"description": "The unique identifier number of the subscription."
},
"sourceValidityPeriod": {
"$ref": "#/components/schemas/SourceValidityPeriodInfo"
},
"destinationValidityPeriod": {
"$ref": "#/components/schemas/DestinationValidityPeriodInfo"
}
}
}
],
"example": {
"prepaymentUom": "Each",
"subscriptionNumber": "A-S00000009",
"sourceValidityPeriod": {
"endDate": "2025-01-01",
"startDate": "2024-01-01"
},
"destinationValidityPeriod": {
"endDate": "2024-01-01",
"startDate": "2023-01-01"
}
}
}
POSTReverseRolloverResponseType
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Indicates the result."
},
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded."
},
"reverseRolloverFundCount": {
"type": "integer",
"format": "int64",
"description": "Indicates the number of funds which have been rolled back."
}
}
}
POSTScCreateType
{
"allOf": [
{
"type": "object",
"required": [
"productRatePlanChargeId"
],
"properties": {
"price": {
"type": "number",
"description": "Price for units in the subscription rate plan.\n"
},
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTTierType"
},
"description": "Container for Volume, Tiered, or Tiered with Overage charge models. Supports the following charge types:\n\n* One-time\n* Recurring\n* Usage-based\n"
},
"number": {
"type": "string",
"description": "Unique number that identifies the charge. Max 50 characters. System-generated if not provided.\n"
},
"quantity": {
"type": "number",
"description": "Number of units. Must be a decimal >=`0`. \n\nWhen using `chargeOverrides` for creating subscriptions with recurring charge types, the `quantity` field must be populated when the charge model is \"Tiered Pricing\" or \"Volume Pricing\". It is not required for \"Flat Fee Pricing\" charge model.\n"
},
"isUnbilled": {
"type": "boolean",
"description": "This field is used to dictate how to perform the accounting during revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"description": {
"type": "string",
"description": "Description of the charge.\n"
},
"ratingGroup": {
"type": "string",
"description": "Specifies a rating group based on which usage records are rated.\n\nPossible values:\n\n- `ByBillingPeriod` (default): The rating is based on all the usages in a billing period.\n- `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. \n- `ByUsageRecord`: The rating is based on each usage record.\n- `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`).\n- `ByGroupId`: The rating is based on all the usages in a custom group.\n\n**Note:** \n- The `ByBillingPeriod` value can be applied for all charge models. \n- The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. \n- The `ByGroupId` value is only available if you have the Active Rating feature enabled.\n- Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`.\n"
},
"triggerDate": {
"type": "string",
"format": "date",
"description": "Specifies when to start billing the customer for the charge. Required if the `triggerEvent` field is set to `USD`.\n"
},
"upToPeriods": {
"type": "integer",
"format": "int64",
"description": "Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.\n\n**Note:** You must use this field together with the `upToPeriodsType` field to specify the time period.\n\n* This field is applicable only when the `endDateCondition` field is set to `Fixed_Period`. \n* If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.\n"
},
"billCycleDay": {
"type": "string",
"description": "Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month the customer is billed.\n\nValues: `1`-`31`\n"
},
"overagePrice": {
"type": "number",
"description": "Price for units over the allowed amount.\n"
},
"triggerEvent": {
"type": "string",
"description": "Specifies when to start billing the customer for the charge.\n\nValues:\n\n* `UCE`\n* `USA`\n* `UCA`\n* `USD`\n"
},
"billCycleType": {
"type": "string",
"description": "Specifies how to determine the billing day for the charge. When this field is set to `SpecificDayofMonth`, set the `BillCycleDay` field. When this field is set to `SpecificDayofWeek`, set the `weeklyBillCycleDay` field.\n\nValues:\n\n* `DefaultFromCustomer`\n* `SpecificDayofMonth`\n* `SubscriptionStartDay`\n* `ChargeTriggerDay`\n* `SpecificDayofWeek`\n"
},
"billingPeriod": {
"type": "string",
"description": "Billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD).\nValues:\n\n* `Month`\n* `Quarter`\n* `Semi_Annual`\n* `Annual`\n* `Eighteen_Months`\n* `Two_Years`\n* `Three_Years`\n* `Five_Years`\n* `Specific_Months`\n* `Subscription_Term`\n* `Week`\n* `Specific_Weeks`\n"
},
"billingTiming": {
"type": "string",
"description": "Billing timing for the charge for recurring charge types. Not avaliable for one time, usage, and discount charges.\n\nValues:\n\n* `IN_ADVANCE` (default)\n* `IN_ARREARS`\n"
},
"discountLevel": {
"type": "string",
"description": "Specifies if the discount applies to the product rate plan only, the entire subscription, or to any activity in the account.\n\nValues:\n\n* `rateplan`\n* `subscription`\n* `account`\n"
},
"includedUnits": {
"type": "number",
"description": "Specifies the number of units in the base set of units for this charge. Must be >=`0`.\n"
},
"listPriceBase": {
"type": "string",
"description": "The list price base for the product rate plan charge.\n\nValues:\n\n* `Per_Billing_Period`\n* `Per_Month`\n* `Per_Week`\n* `Per_Year`\n* `Per_Specific_Months`\n"
},
"discountAmount": {
"type": "number",
"description": "Specifies the amount of fixed-amount discount.\n"
},
"applyDiscountTo": {
"type": "string",
"description": "Specifies the type of charges that you want a specific discount to apply to.\n\nValues:\n\n* `ONETIME`\n* `RECURRING`\n* `USAGE`\n* `ONETIMERECURRING`\n* `ONETIMEUSAGE`\n* `RECURRINGUSAGE`\n* `ONETIMERECURRINGUSAGE`\n"
},
"numberOfPeriods": {
"type": "integer",
"format": "int64",
"description": "Specifies the number of periods to use when calculating charges in an overage smoothing charge model.\n"
},
"specificEndDate": {
"type": "string",
"format": "date",
"description": "Defines when the charge ends after the charge trigger date.\n\n**Note**:\n\n* This field is only applicable when the `endDateCondition` field is set to `Specific_End_Date`.\n\n* If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date.\n"
},
"upToPeriodsType": {
"type": "string",
"description": "\nThe period type used to define when the charge ends. \n\nValues:\n\n* `Billing_Periods`\n* `Days`\n* `Weeks`\n* `Months`\n* `Years`\n\nYou must use this field together with the `upToPeriods` field to specify the time period.\n\nThis field is applicable only when the `endDateCondition` field is set to `Fixed_Period`. \n"
},
"amendedByOrderOn": {
"type": "string",
"description": "The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n"
},
"endDateCondition": {
"type": "string",
"description": "Defines when the charge ends after the charge trigger date. If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date.\n\nValues:\n\n* `Subscription_End`\n* `Fixed_Period`\n* `Specific_End_Date`\n* `One_Time`\n"
},
"originalOrderDate": {
"type": "string",
"format": "date",
"description": "The date when the rate plan charge is created through an order or amendment. This field is not updatable.\n\nThis field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n"
},
"priceChangeOption": {
"type": "string",
"description": "Applies an automatic price change when a termed subscription is renewed. The Billing Admin setting **Enable Automatic Price Change When Subscriptions are Renewed?** must be set to Yes to use this field.\nValues:\n\n* `NoChange` (default)\n* `SpecificPercentageValue`\n* `UseLatestProductCatalogPricing`\n"
},
"discountPercentage": {
"type": "number",
"description": "Percentage of discount for a percentage discount. \n"
},
"weeklyBillCycleDay": {
"type": "string",
"description": "Specifies which day of the week is the bill cycle day (BCD) for the charge. \n\nValues:\n\n* `Sunday`\n* `Monday`\n* `Tuesday`\n* `Wednesday`\n* `Thursday`\n* `Friday`\n* `Saturday`\n"
},
"isAllocationEligible": {
"type": "boolean",
"description": "This field is used to identify if the charge segment is allocation eligible in revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"specificBillingPeriod": {
"type": "integer",
"format": "int64",
"description": "Specifies the number of month or week for the charges billing period. Required if you set the value of the `billingPeriod` field to `Specific_Months` or `Specific_Weeks`.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"description": "The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.\n\n**Note**: \n - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.\n"
},
"billingPeriodAlignment": {
"type": "string",
"description": "Aligns charges within the same subscription if multiple charges begin on different dates.\n\nValues:\n\n* `AlignToCharge`\n* `AlignToSubscriptionStart`\n* `AlignToTermStart`\n"
},
"unusedUnitsCreditRates": {
"type": "number",
"description": "Specifies the rate to credit a customer for unused units of usage. This field applies only for overage charge models when the `OverageUnusedUnitsCreditOption` field is set to `CreditBySpecificRate`.\n"
},
"priceIncreasePercentage": {
"type": "number",
"description": "Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the `PriceChangeOption` field to `SpecificPercentageValue`. \n\nValue must be a decimal between `-100` and `100`.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "ID of a product rate-plan charge for this subscription.\n"
},
"chargeModelConfiguration": {
"$ref": "#/components/schemas/ChargeModelConfigurationType"
},
"productRatePlanChargeNumber": {
"type": "string",
"description": "Number of a product rate-plan charge for this subscription.\n"
},
"overageUnusedUnitsCreditOption": {
"type": "string",
"description": "Determines whether to credit the customer with unused units of usage.\n\nValues:\n\n* `NoCredit`\n* `CreditBySpecificRate`\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.\n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charges from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.\n"
}
}
},
{
"$ref": "#/components/schemas/RatePlanChargeObjectCustomFields"
}
],
"title": "chargeOverrides"
}
POSTScheduleItemType
{
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 100,
"description": "The name of the invoice schedule item.\n"
},
"amount": {
"type": "string",
"format": "number",
"description": "The amount of the invoice to be generated during the processing of the invoice schedule item. \n\nYou can only specify either the `amount` field or `percentage` field in one request. \n - If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. \n - If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount. \n"
},
"runDate": {
"type": "string",
"format": "date",
"description": "The date in the tenant’s time zone when the invoice schedule item is planned to be processed to generate an invoice.\n\n\nWhen specifying run dates for invoice schedule items, consider that:\n- An invoice schedule item with a blank run date will not be executed.\n- You can only update the run date for an invoice schedule item in Pending status.\n- If the run date of an invoice schedule item is left empty, the dates of all subsequent invoice schedule items must also be blank.\n- You must specify run dates in chronological order for invoice schedule items. \n"
},
"percentage": {
"type": "string",
"format": "number",
"maximum": 100,
"description": "The percentage of the total amount to be billed during the processing of the invoice schedule item. \n\nYou can only specify either the `amount` field or `percentage` field in one request. \n - If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. \n - If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount.\n"
},
"targetDateForAdditionalSubscriptions": {
"type": "string",
"format": "date",
"description": "The date in the tenant's time zone used by the invoice schedule to determine which fixed-period regular charges to be billed together with the invoice schedule item. \n\nThe regular charges must come from the subscriptions specified in the `additionalSubscriptionsToBill` field.\n"
}
}
},
{
"$ref": "#/components/schemas/InvoiceScheduleItemCustomFields"
},
{}
],
"title": "scheduleItems"
}
POSTSequenceSetRequest
{
"type": "object",
"title": "sequenceSets",
"required": [
"name",
"invoice",
"creditMemo",
"debitMemo"
],
"properties": {
"name": {
"type": "string",
"example": "FRANCE",
"description": "The name of the sequence set to configure for billing documents, payments, and refunds.\n"
},
"refund": {
"$ref": "#/components/schemas/RefundEntityPrefix"
},
"invoice": {
"$ref": "#/components/schemas/InvoiceEntityPrefix"
},
"payment": {
"$ref": "#/components/schemas/PaymentEntityPrefix"
},
"debitMemo": {
"$ref": "#/components/schemas/DebitMemoEntityPrefix"
},
"creditMemo": {
"$ref": "#/components/schemas/CreditMemoEntityPrefix"
}
},
"description": ""
}
POSTSequenceSetsRequest
{
"type": "object",
"example": {
"sequenceSets": [
{
"name": "FR",
"refund": {
"prefix": "FR-",
"startNumber": 10
},
"invoice": {
"prefix": "FINV",
"startNumber": 10
},
"payment": {
"prefix": "FP-",
"startNumber": 10
},
"debitMemo": {
"prefix": "FDM",
"startNumber": 10
},
"creditMemo": {
"prefix": "FCM",
"startNumber": 10
}
},
{
"name": "ITA",
"refund": {
"prefix": "IR-",
"startNumber": 10
},
"invoice": {
"prefix": "IINV",
"startNumber": 10
},
"payment": {
"prefix": "IP-",
"startNumber": 10
},
"debitMemo": {
"prefix": "IDM",
"startNumber": 10
},
"creditMemo": {
"prefix": "ICM",
"startNumber": 10
}
}
]
},
"properties": {
"sequenceSets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTSequenceSetRequest"
},
"description": "Array of sequence sets configured for billing documents, payments, and refunds.\n"
}
},
"description": ""
}
POSTSequenceSetsResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true,
"description": "Indicates whether the call succeeded.\n"
},
"sequenceSets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETSequenceSetResponse"
},
"description": "Array of sequence sets configured for billing documents, payments, and refunds.\n"
}
},
"description": ""
}
POSTSettlePaymentRequest
{
"type": "object",
"example": {
"payoutId": "PAYOUT123",
"settledOn": "2019-05-07 20:56:32.981",
"gatewayReconciliationReason": "paid",
"gatewayReconciliationStatus": "succeeded"
},
"properties": {
"payoutId": {
"type": "string",
"description": "The payout ID from the gateway side.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time of the transaction settlement. The format is `yyyy-mm-dd hh:mm:ss`.\n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
}
POSTSettlePaymentResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the payment chargeback.\n"
},
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the payment.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the payment. For example, P-00000001.\n"
},
"status": {
"type": "string",
"description": "The status of the payment.\n"
},
"comment": {
"type": "string",
"description": "Comments about the payment.\n"
},
"success": {
"type": "boolean",
"description": "Indicates if the request is processed successfully.\n"
},
"currency": {
"type": "string",
"description": "A currency defined in the web-based UI administrative settings.\n"
},
"payoutId": {
"type": "string",
"description": "The payout ID from the gateway side.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account that the payment is for.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the payment.\n"
},
"settledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the transaction is settled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the refund.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the chargeback is created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2019-03-01 15:31:10.\n"
},
"referenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n"
},
"submittedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was submitted, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the payment.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2019-03-02 15:36:10.\n"
},
"gatewayState": {
"enum": [
"Submitted",
"NotSubmitted",
"Settled",
"FailedToSettle"
],
"type": "string",
"description": "The status of the payment in the gateway; specifically used for reconciliation.\n"
},
"refundAmount": {
"type": "number",
"format": "double",
"description": "The amount of the payment that is refunded.\n"
},
"appliedAmount": {
"type": "number",
"format": "double",
"description": "The applied amount of the payment.\n"
},
"effectiveDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the payment takes effect, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"gatewayOrderId": {
"type": "string",
"description": "A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead.\n"
},
"softDescriptor": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways.\n"
},
"gatewayResponse": {
"type": "string",
"description": "The message returned from the payment gateway for the payment. This message is gateway-dependent.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The unique ID of the payment method that the customer used to make the payment.\n"
},
"unappliedAmount": {
"type": "number",
"format": "double",
"description": "The unapplied amount of the payment.\n"
},
"authTransactionId": {
"type": "string",
"description": "The authorization transaction ID from the payment gateway.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"bankAccountAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code that maps to a bank account in your accounting system.\n \n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the unapplied payment.\n"
},
"unappliedPaymentAccountingCodeType": {
"type": "string",
"description": "The type of the accounting code for the unapplied payment.\n \n"
}
},
"description": "Container for the finance information related to the refund.\n"
},
"creditBalanceAmount": {
"type": "number",
"format": "double",
"description": "The amount that the payment transfers to the credit balance. The value is not `0` only for those payments that come from legacy payment operations performed without the Invoice Settlement feature.\n"
},
"gatewayResponseCode": {
"type": "string",
"description": "The code returned from the payment gateway for the payment. This code is gateway-dependent.\n"
},
"softDescriptorPhone": {
"type": "string",
"description": "A payment gateway-specific field that maps Zuora to other gateways.\n"
},
"markedForSubmissionOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when a charge was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"paymentMethodSnapshotId": {
"type": "string",
"description": "The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction.\n"
},
"bankIdentificationNumber": {
"type": "string",
"description": "The first six or eight digits of the credit card or debit card used for the payment, when applicable.\n"
},
"secondPaymentReferenceId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the payment. \n"
},
"gatewayReconciliationReason": {
"type": "string",
"description": "The reason of gateway reconciliation.\n"
},
"gatewayReconciliationStatus": {
"type": "string",
"description": "The status of gateway reconciliation.\n"
}
}
}
POSTSrpCreateType
{
"allOf": [
{
"type": "object",
"properties": {
"chargeOverrides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTScCreateType"
},
"description": "This optional container is used to override the quantity of one or more product rate plan charges for this subscription.\n"
},
"productRatePlanId": {
"type": "string",
"description": "ID of a product rate plan for this subscription.\n"
},
"externalCatalogPlanId": {
"type": "string",
"description": "An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.\n\n**Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription.\n"
},
"externalIdSourceSystem": {
"type": "string",
"description": "The ID of the external source system. You can use this field and `externalCatalogPlanId` to specify a product rate plan that is imported from an external system.\n\n**Note:** If both `externalCatalogPlanId`, `externalIdSourceSystem` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.\n"
},
"externallyManagedPlanId": {
"type": "string",
"description": "Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n"
}
}
},
{
"$ref": "#/components/schemas/RatePlanObjectCustomFields"
}
],
"title": "subscribeToRatePlans"
}
POSTSubscriptionCancellationResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"invoiceId": {
"type": "string",
"description": "ID of the invoice, if one is generated.\n"
},
"paymentId": {
"type": "string",
"description": "ID of the payment, if a payment is collected.\n"
},
"paidAmount": {
"type": "number",
"description": "Amount paid.\n"
},
"creditMemoId": {
"type": "string",
"description": "The credit memo ID, if a credit memo is generated during the subscription process.\n\n**Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, and 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"cancelledDate": {
"type": "string",
"format": "date",
"description": "The date that the subscription was canceled. \n\nThis field is available in the Orders Harmonization tenants and the Subscribe and Amend tenants. This field is not available in the Orders tenants. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Common_subscription_information/AA_Overview_of_Subscriptions\" target=\"_blank\">Identify your tenant type for managing subscriptions</a>.\n"
},
"totalDeltaMrr": {
"type": "number",
"description": "Change in the subscription monthly recurring revenue as a result of the update.\n"
},
"totalDeltaTcv": {
"type": "number",
"description": "Change in the total contracted value of the subscription as a result of the update.\n"
},
"subscriptionId": {
"type": "string",
"description": "The subscription ID.\n"
}
}
}
POSTSubscriptionCancellationType
{
"type": "object",
"example": {
"collect": false,
"runBilling": true,
"cancellationPolicy": "SpecificDate",
"creditMemoReasonCode": "Unsatisfactory service",
"cancellationEffectiveDate": "2019-05-31"
},
"required": [
"cancellationPolicy"
],
"properties": {
"collect": {
"type": "boolean",
"default": false,
"description": "Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.\n\nIf the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.\n\nPrerequisite: The `invoice` or `runBilling` field must be `true`. \n\n**Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"invoice": {
"type": "boolean",
"description": "**Note:** This field has been replaced by the `runBilling` field. The\n`invoice` field is only available for backward compatibility.\n\n\nCreates an invoice for a subscription. The invoice generated in this\noperation is only for this subscription, not for the entire customer\naccount.\n\n\nIf the value is `true`, an invoice is created. If the value is\n`false`, no action is taken. The default value is `false`. \n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `196.0` and `207.0`. To use this field in the method, you\nmust set the zuora-version parameter to the minor version number in\nthe request header.\n"
},
"orderDate": {
"type": "string",
"format": "date",
"description": "The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date.\nThis field must be in the `yyyy-mm-dd` format.\nThis field is required for Orders customers only, not applicable to Orders Harmonization customers. \n"
},
"runBilling": {
"enum": [
true,
false
],
"type": "boolean",
"default": false,
"description": "Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos). \n\n\nThe billing documents generated\nin this operation is only for this subscription, not for the entire\ncustomer account.\n\n\nPossible values:\n\n- `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.\n\n\n- `false`: No invoice is created.\n\n\n**Note:** This field is in Zuora REST API version control. Supported\nminor versions are `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). To use this field in the method,\nyou must set the `zuora-version` parameter to the minor version number\nin the request header.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice or a credit memo is generated, as\nyyyy-mm-dd. Default is current date.\n\n\n**Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.\n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `211.0` and later. To use this field in the method, you\nmust set the `zuora-version` parameter to the minor version number in\nthe request header.\n"
},
"applyCredit": {
"type": "boolean",
"description": "If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.\n\n**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"bookingDate": {
"type": "string",
"format": "date",
"description": "The booking date that you want to set for the amendment contract when you cancel the subscription. The default value is the current date when you make the API call.\n"
},
"documentDate": {
"type": "string",
"format": "date",
"description": "The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.\n\n- If this field is specified, the specified date is used as the billing document date. \n- If this field is not specified, the date specified in the `targetDate` is used as the billing document date.\n"
},
"invoiceCollect": {
"type": "boolean",
"default": false,
"description": "This field has been replaced by the `invoice` field and the\n`collect` field. `invoiceCollect` is available only for backward compatibility.\n\nIf this field is set to `true`, an invoice is generated and payment automatically collected.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`.\n"
},
"applicationOrder": {
"type": "array",
"items": {
"type": "string"
},
"description": "The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.\n\n**Note:**\n - This field is valid only if the `applyCredit` field is set to `true`.\n - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.\n - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.\n"
},
"invoiceTargetDate": {
"type": "string",
"format": "date",
"description": "**Note:** This field has been replaced by the `targetDate` field. The\n`invoiceTargetDate` field is only available for backward\ncompatibility.\n\n\nDate through which to calculate charges if an invoice is generated, as\nyyyy-mm-dd. Default is current date.\n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `207.0` and earlier [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"applyCreditBalance": {
"type": "boolean",
"description": "Whether to automatically apply a credit balance to an invoice.\n\nIf the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.\n\n\nTo view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.\n\nPrerequisite: `invoice` must be `true`. \n\n**Note:** \n - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.\n - This field is deprecated if you have the Invoice Settlement feature enabled.\n"
},
"cancellationPolicy": {
"type": "string",
"description": "Cancellation method. Possible values are: `EndOfCurrentTerm`, `EndOfLastInvoicePeriod`, `SpecificDate`. If using `SpecificDate`, the `cancellationEffectiveDate` field is required.\n"
},
"creditMemoReasonCode": {
"type": "string",
"description": "A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code."
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the customer notifies you that they want to cancel their subscription.\n"
},
"cancellationEffectiveDate": {
"type": "string",
"format": "date",
"description": "Date the cancellation takes effect, in the format yyyy-mm-dd. Use only if `cancellationPolicy` is `SpecificDate`. Should not be earlier than the subscription contract-effective date, later than the subscription term-end date, or within a period for which the customer has been invoiced.\n"
}
}
}
POSTSubscriptionPreviewCreditMemoItemsType
{
"type": "object",
"title": "creditMemoItems",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity of the charge associated with this credit memo item.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The tax amount of the credit memo item.\n"
},
"chargeName": {
"type": "string",
"description": "Name of this credit memo item.\n"
},
"productName": {
"type": "string",
"description": "Name of the product associated with this credit memo item.\n"
},
"chargeAmount": {
"type": "number",
"format": "double",
"description": "The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax\n"
},
"taxationItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTSubscriptionPreviewTaxationItemsType"
},
"description": "List of taxation items.\n**Note**: This field is only available if you set the `zuora-version` request header to `315.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). "
},
"unitOfMeasure": {
"type": "string",
"description": "Unit used to measure consumption."
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "End date of the service period for this credit memo item, as yyyy-mm-dd.\n"
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "The credit memo item amount excluding tax.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "Service start date of this credit memo item, as yyyy-mm-dd.\n"
},
"chargeDescription": {
"type": "string",
"description": "Description of this credit memo item.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "ID of the product rate plan charge associated with this credit memo item.\n"
}
}
}
POSTSubscriptionPreviewInvoiceItemsType
{
"type": "object",
"title": "invoiceItems",
"properties": {
"quantity": {
"type": "number",
"description": "Quantity of this item.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The tax amount of the invoice item.\n"
},
"chargeName": {
"type": "string",
"description": "Name of the charge.\n"
},
"productName": {
"type": "string",
"description": "Name of the product associated with this item.\n"
},
"chargeAmount": {
"type": "number",
"description": "The amount of the charge. This amount doesn't include taxes unless the charge's tax mode is inclusive.\n"
},
"taxationItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTSubscriptionPreviewTaxationItemsType"
},
"description": "List of taxation items.\n**Note**: This field is only available if you set the `zuora-version` request header to `315.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). "
},
"unitOfMeasure": {
"type": "string",
"description": ""
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge.\n"
},
"chargeDescription": {
"type": "string",
"description": "Description of the charge.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "ID of the product rate plan charge.\n"
}
}
}
POSTSubscriptionPreviewResponseType
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Invoice amount.\n"
},
"invoice": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Invoice amount."
},
"taxAmount": {
"type": "number",
"description": "The tax amount of the invoice.\n"
},
"targetDate": {
"type": "string",
"description": "Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.\n\n**Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTSubscriptionPreviewInvoiceItemsType"
},
"description": "Container for invoice items.\n"
},
"amountWithoutTax": {
"type": "number",
"description": "Invoice amount minus tax.\n"
}
},
"description": "Container for invoices.\n\n\n **Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header. Also, the response structure is changed and the following invoice related response fields are moved to this **invoice** container:\n \n * amount\n * amountWithoutTax\n * taxAmount\n * invoiceItems\n * targetDate\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"taxAmount": {
"type": "number",
"description": "Tax amount on the invoice.\n"
},
"creditMemo": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "Credit memo amount."
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "Tax amount on the credit memo."
},
"creditMemoItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTSubscriptionPreviewCreditMemoItemsType"
},
"description": ""
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "Credit memo amount minus tax."
}
},
"description": "\nContainer for credit memos.\n\n**Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, and 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.\n\n**Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header.\n"
},
"documentDate": {
"type": "string",
"format": "date",
"description": "The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.\n\n- If this field is specified, the specified date is used as the billing document date. \n- If this field is not specified, the date specified in the `targetDate` is used as the billing document date.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTSubscriptionPreviewInvoiceItemsType"
},
"description": "Container for invoice items.\n"
},
"chargeMetrics": {
"type": "object",
"properties": {
"mrr": {
"type": "string",
"description": "Monthly recurring revenue.\n"
},
"tcv": {
"type": "string",
"description": "Total contract value.\n"
},
"dmrr": {
"type": "string",
"description": "Change in monthly recurring revenue.\n"
},
"dtcv": {
"type": "string",
"description": "Change in total contract value.\n"
},
"number": {
"type": "string",
"description": "The charge number of the subscription. Only available for update subscription.\n"
},
"originalId": {
"type": "string",
"description": "The original rate plan charge ID. Only available for update subscription.\n"
},
"originRatePlanId": {
"type": "string",
"description": "The origin rate plan ID. Only available for update subscription.\n"
},
"productRatePlanId": {
"type": "string",
"description": "The product rate plan ID.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The product rate plan charge ID.\n"
}
},
"description": "Container for charge metrics.\n"
},
"contractedMrr": {
"type": "number",
"description": "Monthly recurring revenue of the subscription.\n"
},
"amountWithoutTax": {
"type": "number",
"description": "Invoice amount minus tax.\n"
},
"invoiceTargetDate": {
"type": "string",
"format": "date",
"description": "Date through which charges are calculated on the invoice, as yyyy-mm-dd.\n\n**Note:** This field is only available if you do not specify the Zuora REST API minor version or specify the minor version to 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0.\n"
},
"totalContractedValue": {
"type": "number",
"description": "Total contracted value of the subscription.\n"
}
}
}
POSTSubscriptionPreviewTaxationItemsType
{
"type": "object",
"title": "taxationItems",
"properties": {
"name": {
"type": "string",
"description": "The name of the taxation item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific invoice.\n"
},
"taxDate": {
"type": "string",
"description": "The date when the tax is applied to the invoice.\n"
},
"taxRate": {
"type": "number",
"description": "The tax rate applied to the invoice. "
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The tax amount of the invoice item.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "Enum:\"Percentage\" \"FlatFee\". The type of the tax rate applied to the invoice.\n"
},
"exemptAmount": {
"type": "number",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the taxCode field.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
}
}
}
POSTSubscriptionPreviewType
{
"allOf": [
{
"type": "object",
"required": [
"termType",
"contractEffectiveDate",
"subscribeToRatePlans"
],
"properties": {
"notes": {
"type": "string",
"description": "String of up to 500 characters."
},
"termType": {
"type": "string",
"description": "Possible values are: `TERMED`, `EVERGREEN`.\n"
},
"accountKey": {
"type": "string",
"description": "\nCustomer account number or ID.\n\nYou must specify the account information either in this field or in the `previewAccountInfo` field with the following conditions:\n \n* If you already have a customer account, specify the account number or ID in this field.\n* If you do not have a customer account, provide account information in the `previewAccountInfo` field.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.\n\n**Note:** This field is in Zuora REST API version control. Supported minor versions are 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header.\n"
},
"initialTerm": {
"type": "integer",
"format": "int64",
"description": "Duration of the first term of the subscription, in whole months. If `termType` is `TERMED`, then this field is required, and the value must be greater than `0`. If `termType` is `EVERGREEN`, this field is ignored. \n"
},
"previewType": {
"type": "string",
"description": "The type of preview you will receive. \n\nThis field is in Zuora REST API version control. The supported values of this field depend on the REST API minor version you specified in the request header.\n\n\n* If you do not specify the REST API minor version or specify the minor version number to one of following values in the request header:\n \n * 186.0\n * 187.0\n * 188.0\n * 189.0\n * 196.0\n * 206.0\n \n The following values are supported in the **previewType** field:\n\n * InvoiceItem\n * ChargeMetrics\n * InvoiceItemChargeMetrics\n \n The default value is InvoiceItem.\n\n* If you specify the REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, the following values are supported in the **previewType** field:\n\n - LegalDoc\n - ChargeMetrics\n - LegalDocChargeMetrics\n\n The default value is LegalDoc.\n\n.\n"
},
"documentDate": {
"type": "string",
"format": "date",
"description": "The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.\n\n- If this field is specified, the specified date is used as the billing document date. \n- If this field is not specified, the date specified in the `targetDate` is used as the billing document date.\n"
},
"termStartDate": {
"type": "string",
"format": "date",
"description": "The date on which the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date.\n"
},
"invoiceTargetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.\n\n**Note:** This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. .\n"
},
"previewAccountInfo": {
"$ref": "#/components/schemas/POSTSubscriptionPreviewTypePreviewAccountInfo"
},
"subscribeToRatePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTSrpCreateType"
},
"description": "Container for one or more rate plans for this subscription.\n"
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "Effective contract date for this subscription, as yyyy-mm-dd.\n"
},
"initialTermPeriodType": {
"type": "string",
"description": "The period type of the initial term. \n\nSupported values are:\n\n* `Month`\n* `Year`\n* `Day`\n* `Week`\n \nThe default period type is `Month`.\n\n"
},
"serviceActivationDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd.\n\nDefault value is dependent on the value of other fields. See **Notes** section for more details.\n"
},
"customerAcceptanceDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.\n\nDefault value is dependent on the value of other fields. See **Notes** section for more details.\n"
},
"invoiceOwnerAccountKey": {
"type": "string",
"description": "Invoice owner account number or ID.\n\n**Note:** 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"
},
"includeExistingDraftDocItems": {
"type": "boolean",
"description": "Specifies whether to include draft invoice items in subscription previews.\nValues are:\n\n* `true` (default). Includes draft invoice items in the preview result.\n* `false`. Excludes draft invoice items in the preview result.\n\n**Note:** This field is in Zuora REST API version control. Supported minor versions are 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"includeExistingDraftInvoiceItems": {
"type": "boolean",
"description": "Specifies whether to include draft invoice items in previews.\nValues are:\n\n* `true` (default). Includes draft invoice items in the preview result.\n* `false`. Excludes draft invoice items in the preview result.\n\n**Note:** This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0.\n"
}
}
},
{
"$ref": "#/components/schemas/SubscriptionObjectCustomFields"
}
],
"example": {
"termType": "TERMED",
"initialTerm": 12,
"invoiceTargetDate": "2013-12-31",
"previewAccountInfo": {
"currency": "USD",
"billCycleDay": 31,
"billToContact": {
"city": "Walnut Creek",
"state": "California",
"county": "Contra Consta",
"country": "United States",
"zipCode": "94549"
}
},
"subscribeToRatePlans": [
{
"chargeOverrides": [
{
"quantity": 100,
"productRatePlanChargeId": "ff8080811ca15d19011cddad8c953b53"
}
],
"productRatePlanId": "ff8080811ca15d19011cdda9b0ad3b51"
}
],
"contractEffectiveDate": "2013-01-15",
"initialTermPeriodType": "Week"
}
}
POSTSubscriptionPreviewTypePreviewAccountInfo
{
"allOf": [
{
"type": "object",
"required": [
"billCycleDay",
"billToContact",
"currency"
],
"properties": {
"currency": {
"type": "string",
"description": "A currency as defined in Billing Settings.\n"
},
"billCycleDay": {
"type": "integer",
"format": "int64",
"description": "The account's bill cycle day (BCD), when bill runs generate invoices for the account. Specify any day of the month (`1`-`31`, where `31` = end-of-month), or `0` for auto-set.\n"
},
"billToContact": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city of the bill-to address. The value should be 40 characters or less.\n"
},
"state": {
"type": "string",
"description": "The state of the bill-to address. The value must be a valid state or province name or 2-character abbreviation.\n\n**Note:** You must specify this field if you are using Zuora Tax for this account and the country is `USA` or `Canada`.\n"
},
"county": {
"type": "string",
"description": "The county of the bill-to address. The value should be 32 characters or less.\n"
},
"country": {
"type": "string",
"description": "The country of the bill-to address. The value must be a valid country name or abbreviation.\n\n**Note:** You must specify this field if you are using Zuora Tax for this account.\n"
},
"zipCode": {
"type": "string",
"description": "The zip code of the bill-to address. The value should be 20 characters or less.\n"
},
"taxRegion": {
"type": "string",
"description": "If using Zuora Tax, a region string as optionally defined in your tax rules.\n"
}
},
"description": "Container for bill-to contact information of this account.\n"
}
}
},
{
"$ref": "#/components/schemas/AccountObjectNSFields"
},
{
"$ref": "#/components/schemas/AccountObjectCustomFields"
}
],
"title": "previewAccountInfo",
"description": "A container for providing a customer account information if you do not have an existing customer account. This customer account information is only used for subscription preview.\n\nYou must specify the account information either in this field or in the `accountKey` field with the following conditions:\n\n* If you already have a customer account, specify the account number or ID in the accountKey field.\n* If you do not have a customer account, provide account information in this field.\n"
}
POSTSubscriptionResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"invoiceId": {
"type": "string",
"description": "Invoice ID, if an invoice is generated during the subscription process.\n"
},
"paymentId": {
"type": "string",
"description": "Payment ID, if a payment is collected.\n"
},
"paidAmount": {
"type": "number",
"description": "Payment amount, if a payment is collected.\n"
},
"creditMemoId": {
"type": "string",
"description": "The credit memo ID, if a credit memo is generated during the subscription process.\n\n**Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, and 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"contractedMrr": {
"type": "number",
"description": "Monthly recurring revenue of the subscription.\n"
},
"subscriptionId": {
"type": "string",
"description": ""
},
"subscriptionNumber": {
"type": "string",
"description": ""
},
"totalContractedValue": {
"type": "number",
"description": "Total contracted value of the subscription.\n"
}
}
}
POSTSubscriptionType
{
"allOf": [
{
"type": "object",
"required": [
"accountKey",
"contractEffectiveDate",
"subscribeToRatePlans",
"termType",
"renewalTerm"
],
"properties": {
"notes": {
"type": "string",
"description": "String of up to 500 characters.\n"
},
"collect": {
"type": "boolean",
"default": true,
"description": "Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.\n\nIf the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.\n\nPrerequisite: The `invoice` or `runBilling` field must be `true`. \n\n**Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"invoice": {
"type": "boolean",
"description": "**Note:** This field has been replaced by the `runBilling` field. The\n`invoice` field is only available for backward compatibility.\n\n\nCreates an invoice for a subscription. The invoice generated in this\noperation is only for this subscription, not for the entire customer\naccount.\n\n\nIf the value is `true`, an invoice is created. If the value is\n`false`, no action is taken. The default value is `true`. \n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `196.0` and `207.0`. To use this field in the method, you\nmust set the zuora-version parameter to the minor version number in\nthe request header.\n"
},
"termType": {
"type": "string",
"description": "Possible values are: `TERMED`, `EVERGREEN`.\n"
},
"autoRenew": {
"type": "boolean",
"default": false,
"description": "If true, this subscription automatically renews at the end of the subscription term.\n\nThis field is only required if the `termType` field is set to `TERMED`.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the payment gateway instance. For example, `2c92c0f86078c4d5016091674bcc3e92`.\n\nIf <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Payment_Gateway_Routing\" target=\"_blank\">Payment Gateway Routing</a> is enabled: \n - If this field is not specified, gateway routing rules will be invoked.\n - If this field is specified, the specified gateway will be used to process the payment.\n\nIf Payment Gateway Routing is disabled:\n - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. \n - If this field is specified, the specified gateway will be used to process the payment.\n"
},
"accountKey": {
"type": "string",
"description": "Customer account number or ID\n"
},
"prepayment": {
"type": "boolean",
"description": "Indicates whether the subscription will consume the reserved payment amount of the customer account. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information. \n"
},
"runBilling": {
"enum": [
true,
false
],
"type": "boolean",
"default": true,
"description": "Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos). \n\n\nThe billing documents generated\nin this operation is only for this subscription, not for the entire\ncustomer account.\n\n\nPossible values:\n\n- `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.\n\n\n- `false`: No invoice is created.\n\n\n**Note:** This field is in Zuora REST API version control. Supported\nminor versions are `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). To use this field in the method,\nyou must set the `zuora-version` parameter to the minor version number\nin the request header.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice or a credit memo is generated, as\nyyyy-mm-dd. Default is current date.\n\n\n**Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.\n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `211.0` and later. To use this field in the method, you\nmust set the `zuora-version` parameter to the minor version number in\nthe request header.\n"
},
"applyCredit": {
"type": "boolean",
"description": "If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.\n\n\n**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"initialTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the first subscription term. If `termType` is `TERMED`, then this field is required, and the value must be greater than `0`. If `termType` is `EVERGREEN`, this field is ignored.\n"
},
"renewalTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the subscription renewal term. Default is `0`.\n"
},
"documentDate": {
"type": "string",
"format": "date",
"description": "The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.\n\n- If this field is specified, the specified date is used as the billing document date. \n- If this field is not specified, the date specified in the `targetDate` is used as the billing document date.\n"
},
"termStartDate": {
"type": "string",
"format": "date",
"description": "The date on which the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date.\n"
},
"invoiceCollect": {
"type": "boolean",
"default": true,
"description": "**Note:** This field has been replaced by the `invoice` field\nand the `collect` field. `invoiceCollect` is available only for backward compatibility.\n\n\nIf this field is set to `true`, an invoice is generated and payment collected automatically\nduring the subscription process. If `false`, no invoicing or payment takes\nplace. The invoice generated in this operation is only for this subscription,\nnot for the entire customer account.\n\n\n**Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`.\n"
},
"renewalSetting": {
"type": "string",
"description": "Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed.\n\nValues:\n\n* `RENEW_WITH_SPECIFIC_TERM` (default)\n* `RENEW_TO_EVERGREEN`\n"
},
"lastBookingDate": {
"type": "string",
"format": "date",
"description": "The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value `today` is set per the user's timezone. The value of this field is as follows:\n* For a new subscription created by the [Subscribe and Amend APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate), this field has the value of the subscription creation date.\n* For a subscription changed by an amendment, this field has the value of the amendment booking date.\n* For a subscription created or changed by an order, this field has the value of the order date. "
},
"paymentMethodId": {
"type": "string",
"description": "The ID of the payment method used for the payment.\n"
},
"applicationOrder": {
"type": "array",
"items": {
"type": "string"
},
"description": "The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.\n\n**Note:**\n - This field is valid only if the `applyCredit` field is set to `true`.\n - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.\n - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.\n"
},
"invoiceSeparately": {
"type": "boolean",
"description": "Separates a single subscription from other subscriptions and invoices the charge independently. \n\nIf the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice.\n\nThe default value is `false`.\n\nPrerequisite: The default subscription setting Enable Subscriptions to be Invoiced Separately must be set to Yes.\n"
},
"invoiceTargetDate": {
"type": "string",
"format": "date",
"description": "**Note:** This field has been replaced by the `targetDate` field. The\n`invoiceTargetDate` field is only available for backward\ncompatibility.\n\n\nDate through which to calculate charges if an invoice is generated, as\nyyyy-mm-dd. Default is current date.\n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `207.0` and earlier [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"applyCreditBalance": {
"type": "boolean",
"description": "Whether to automatically apply a credit balance to an invoice.\n\nIf the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.\n\n\nTo view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.\n\nPrerequisite: `invoice` must be `true`. \n\n**Note:** \n - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.\n - This field is deprecated if you have the Invoice Settlement feature enabled.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "Subscription Number. The value can be up to 1000 characters.\n\nIf you do not specify a subscription number when creating a subscription, Zuora will generate a subscription number automatically.\n\nIf the account is created successfully, the subscription number is returned in the `subscriptionNumber` response field.\n"
},
"externallyManagedBy": {
"enum": [
"Amazon",
"Apple",
"Google",
"Roku"
],
"type": "string",
"description": "An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.\n"
},
"creditMemoReasonCode": {
"type": "string",
"description": "A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code."
},
"subscribeToRatePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTSrpCreateType"
},
"description": "Container for one or more rate plans for this subscription.\n"
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "Effective contract date for this subscription, as yyyy-mm-dd\n"
},
"initialTermPeriodType": {
"type": "string",
"description": "The period type for the first subscription term.\n\nThis field is used with the `InitialTerm` field to specify the initial subscription term.\n\nValues are:\n\n* `Month` (default)\n* `Year`\n* `Day`\n* `Week`\n"
},
"renewalTermPeriodType": {
"type": "string",
"description": "The period type for the subscription renewal term.\n\nThis field is used with the `renewalTerm` field to specify the subscription renewal term.\n\nValues are:\n\n* `Month` (default)\n* `Year`\n* `Day`\n* `Week`\n"
},
"serviceActivationDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd.\n\nDefault value is dependent on the value of other fields. See **Notes** section for more details.\n"
},
"customerAcceptanceDate": {
"type": "string",
"format": "date",
"description": "The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.\n\nDefault value is dependent on the value of other fields. See **Notes** section for more details.\n"
},
"invoiceOwnerAccountKey": {
"type": "string",
"description": "Invoice owner account number or ID.\n\n**Note:** 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"
}
}
},
{
"$ref": "#/components/schemas/SubscriptionObjectQTFields"
},
{
"$ref": "#/components/schemas/SubscriptionObjectNSFields"
},
{
"$ref": "#/components/schemas/SubscriptionObjectCustomFields"
}
],
"example": {
"notes": "Test POST subscription from z-ruby-sdk",
"termType": "TERMED",
"autoRenew": true,
"accountKey": "A00001115",
"initialTerm": "12",
"renewalTerm": "3",
"creditMemoReasonCode": "Unsatisfactory service",
"subscribeToRatePlans": [
{
"chargeOverrides": [
{
"price": 12.01,
"number": "TestCharge",
"description": "This is rate plan charge description",
"triggerDate": "2015-09-01",
"billCycleDay": "5",
"triggerEvent": "USD",
"billCycleType": "SpecificDayofMonth",
"billingTiming": "IN_ARREARS",
"billingPeriodAlignment": "AlignToCharge",
"productRatePlanChargeId": "ff8080811ca15d19011cddad8c953b53"
}
],
"productRatePlanId": "ff8080811ca15d19011cdda9b0ad3b51"
}
],
"contractEffectiveDate": "2015-02-01",
"initialTermPeriodType": "Week",
"renewalTermPeriodType": "Week"
}
}
POSTTaxationItemForCMType
{
"allOf": [
{
"type": "object",
"required": [
"taxRate",
"jurisdiction",
"name",
"taxRateType",
"taxAmount"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the taxation item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific credit memo.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date when the tax is applied to the credit memo.\n"
},
"taxRate": {
"type": "number",
"format": "double",
"description": "The tax rate applied to the credit memo.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of the tax applied to the credit memo.\n"
},
"memoItemId": {
"type": "string",
"description": "The ID of the credit memo that the taxation item is created for.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate applied to the credit memo.\n"
},
"exemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field.\n"
},
"sourceTaxItemId": {
"type": "string",
"description": "The ID of the taxation item of the invoice, which the credit memo is created from. \n\nIf you want to use this REST API to create taxation items for a credit memo created from an invoice, the taxation items of the invoice must be created or imported through the SOAP API call.\n\n**Note:** \n - This field is only used if the credit memo is created from an invoice. \n - If you do not contain this field in the request body, Zuora will automatically set a value for the `sourceTaxItemId` field based on the tax location code, tax jurisdiction, and tax rate.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"onAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"salesTaxPayableAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the sales taxes payable.\n"
}
},
"description": "Container for the finance information related to the taxation item.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
}
}
},
{
"$ref": "#/components/schemas/TaxationItemObjectCustomFields"
}
],
"title": "taxationItems"
}
POSTTaxationItemForDMType
{
"allOf": [
{
"type": "object",
"required": [
"taxRate",
"jurisdiction",
"name",
"taxRateType",
"taxAmount"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the taxation item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific debit memo.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date when the tax is applied to the debit memo.\n"
},
"taxRate": {
"type": "number",
"format": "double",
"description": "The tax rate applied to the debit memo.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of the tax applied to the debit memo.\n"
},
"memoItemId": {
"type": "string",
"description": "The ID of the debit memo that the taxation item is created for.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate applied to the debit memo.\n"
},
"exemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field.\n"
},
"sourceTaxItemId": {
"type": "string",
"description": "The ID of the taxation item of the invoice, which the debit memo is created from. \n\nIf you want to use this REST API to create taxation items for a debit memo created from an invoice, the taxation items of the invoice must be created or imported through the SOAP API call.\n\n**Note:** \n - This field is only used if the debit memo is created from an invoice. \n - If you do not contain this field in the request body, Zuora will automatically set a value for the `sourceTaxItemId` field based on the tax location code, tax jurisdiction, and tax rate.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"salesTaxPayableAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the sales taxes payable.\n"
}
},
"description": "Container for the finance information related to the taxation item.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
}
}
},
{
"$ref": "#/components/schemas/TaxationItemObjectCustomFields"
}
],
"title": "taxationItems"
}
POSTTaxationItemList
{
"type": "object",
"example": {
"taxationItems": [
{
"name": "STATE TAX",
"taxCode": "ServiceTaxCode",
"taxDate": "2016-09-30",
"taxMode": "TaxExclusive",
"taxRate": 0.0625,
"taxAmount": 0.1,
"taxRateType": "Percentage",
"exemptAmount": 0,
"jurisdiction": "CALIFORNIA",
"locationCode": "06",
"invoiceItemId": "402890555a7e9791015a879f064d0055",
"financeInformation": {
"salesTaxPayableAccountingCode": "Check",
"accountsReceivableAccountingCode": "Check"
},
"taxCodeDescription": "This is tax code description!",
"taxRateDescription": "This is tax rate description!"
}
]
},
"properties": {
"taxationItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTTaxationItemTypeForInvoice"
},
"description": "Container for taxation items.\n"
}
}
}
POSTTaxationItemListForCMType
{
"type": "object",
"example": {
"taxationItems": [
{
"name": "STATE TAX",
"taxCode": "ServiceTaxCode",
"taxDate": "2016-09-30",
"taxRate": 0.0625,
"taxAmount": 0.1,
"memoItemId": "402890555a7e9791015a879f064d0055",
"taxRateType": "Percentage",
"exemptAmount": 0,
"jurisdiction": "CALIFORNIA",
"locationCode": "06",
"sourceTaxItemId": "402890555a7d4022015a7db254e200c1",
"financeInformation": {
"onAccountAccountingCode": "Check",
"salesTaxPayableAccountingCode": "Check"
},
"taxCodeDescription": "This is tax code description!",
"taxRateDescription": "This is tax rate description!"
}
]
},
"properties": {
"taxationItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTTaxationItemForCMType"
},
"description": "Container for taxation items.\n"
}
}
}
POSTTaxationItemListForDMType
{
"type": "object",
"example": {
"taxationItems": [
{
"name": "STATE TAX",
"taxCode": "ServiceTaxCode",
"taxDate": "2016-06-05",
"taxRate": 0.0625,
"taxAmount": 0.01,
"memoItemId": "402890555a7e9791015a87b082980068",
"taxRateType": "Percentage",
"exemptAmount": 0,
"jurisdiction": "CALIFORNIA",
"locationCode": "06",
"sourceTaxItemId": "402890555a7d4022015a7db254e200c2",
"financeInformation": {
"salesTaxPayableAccountingCode": "Check"
},
"taxCodeDescription": "This is tax code description!",
"taxRateDescription": "This is tax rate description!"
},
{
"name": "STATE TAX",
"taxCode": "ServiceTaxCode",
"taxDate": "2016-06-05",
"taxRate": 0.0625,
"taxAmount": 0.02,
"memoItemId": "402890555a7e9791015a87b082d5006a",
"taxRateType": "Percentage",
"exemptAmount": 0,
"jurisdiction": "CALIFORNIA",
"locationCode": "06",
"sourceTaxItemId": "402890555a7d4022015a7db254e200c3",
"financeInformation": {
"salesTaxPayableAccountingCode": "Check"
},
"taxCodeDescription": "This is tax code description!",
"taxRateDescription": "This is tax rate description!"
}
]
},
"properties": {
"taxationItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTTaxationItemForDMType"
},
"description": "Container for taxation items.\n"
}
}
}
POSTTaxationItemTypeForInvoice
{
"allOf": [
{
"type": "object",
"title": "taxItems",
"required": [
"invoiceItemId",
"jurisdiction",
"name",
"taxAmount",
"taxDate",
"taxRate",
"taxRateType"
],
"properties": {
"name": {
"type": "string",
"description": "The name of taxation.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific invoice item.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date that the tax is applied to the invoice item, in `yyyy-mm-dd` format.\n"
},
"taxMode": {
"enum": [
"TaxInclusive",
"TaxExclusive"
],
"type": "string",
"description": "The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.\n"
},
"taxRate": {
"type": "string",
"format": "number",
"description": "The tax rate applied to the invoice item.\n"
},
"taxAmount": {
"type": "string",
"format": "number",
"description": "The amount of the taxation item in the invoice item.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate applied to the invoice item.\n"
},
"exemptAmount": {
"type": "string",
"format": "number",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field.\n"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the invoice associated with the taxation item.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"salesTaxPayableAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the sales taxes payable.\n"
},
"accountsReceivableAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for accounts receivable.\n"
}
},
"description": "Container for the finance information related to the taxation item.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
}
}
},
{
"$ref": "#/components/schemas/TaxationItemObjectCustomFields"
}
]
}
POSTTierType
{
"type": "object",
"title": "tiers",
"required": [
"tier",
"price"
],
"properties": {
"tier": {
"type": "integer",
"format": "int64",
"description": "Unique number that identifies the tier that the price applies to.\n"
},
"price": {
"type": "number",
"description": "Price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.\n"
},
"endingUnit": {
"type": "number",
"description": "End number of a range of units for the tier.\n"
},
"priceFormat": {
"type": "string",
"description": "Indicates if pricing is a flat fee or is per unit.\n\nValues:\n\n* `FlatFee`\n* `PerUnit`\n"
},
"startingUnit": {
"type": "number",
"description": "Starting number of a range of units for the tier.\n"
}
}
}
POSTTriggerRolloverRequestType
{
"allOf": [
{
"type": "object",
"required": [
"subscriptionNumber",
"prepaymentUom",
"sourceValidityPeriod",
"destinationValidityPeriod",
"priority"
],
"properties": {
"priority": {
"type": "string",
"description": "Specifies the priority of rolled over fund in case of drawdown.\n\n**Values**: ApplyLast / ApplyFirst\n"
},
"prepaymentUom": {
"type": "string",
"description": "Specifies the units of measure for prepayment charge. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**.\n\n**Values**: a valid unit of measure\n"
},
"subscriptionNumber": {
"type": "string",
"maxLength": 100,
"description": "The unique identifier number of the subscription."
},
"sourceValidityPeriod": {
"$ref": "#/components/schemas/SourceValidityPeriodInfo"
},
"destinationValidityPeriod": {
"$ref": "#/components/schemas/DestinationValidityPeriodInfo"
}
}
}
],
"example": {
"priority": "ApplyFirst",
"prepaymentUom": "Each",
"subscriptionNumber": "A-S00000009",
"sourceValidityPeriod": {
"endDate": "2024-01-01",
"startDate": "2023-01-01"
},
"destinationValidityPeriod": {
"endDate": "2025-01-01",
"startDate": "2024-01-01"
}
}
}
POSTTriggerRolloverResponseType
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Indicates the result."
},
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded."
},
"rolloverFundCount": {
"type": "integer",
"format": "int64",
"description": "Indicates the number of funds which have been rolled over."
}
}
}
POSTUploadFileResponse
{
"type": "object",
"properties": {
"fileId": {
"type": "string",
"description": "The unique ID of the uploaded PDF file.\n"
},
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded.\n"
}
}
}
POSTUsageResponseType
{
"type": "object",
"properties": {
"size": {
"type": "integer",
"format": "int64",
"description": "The size of the uploaded file in bytes.\n"
},
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded.\n"
},
"checkImportStatus": {
"type": "string",
"description": "The path for checking the status of the import.\n\nThe possible status values at this path are `Pending`, `Processing`, `Completed`, `Canceled`, and `Failed`. Only `Completed` indicates that the file contents were imported successfully.\n"
}
}
}
POSTVoidAuthorize
{
"type": "object",
"example": {
"accountId": "402881e861bd8a7e0161c6a453750026",
"accountNumber": "A00000004",
"transactionId": "5205213224866613203009",
"gatewayOrderId": "A001"
},
"required": [
"transactionId",
"gatewayOrderId"
],
"properties": {
"accountId": {
"type": "string",
"description": "The ID of the customer account. This field is generally required, but is optional if you are using the Ingenico ePayments gateway."
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account. This field is generally required, but is optional if you are using the Ingenico ePayments gateway."
},
"transactionId": {
"type": "string",
"description": "The ID of the transaction."
},
"gatewayOptions": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The name of a gateway-specific parameter.\n"
},
"value": {
"type": "string",
"description": "The value of the gateway-specific parameter.\n"
}
},
"description": "The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).\n\nZuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.\n"
},
"gatewayOrderId": {
"type": "string",
"description": "The order ID for the specific gateway.\n\nThe specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "The ID of the payment gateway instance. This field is required if you do not specify the `accountId` and `accountNumber` fields."
}
}
}
POSTVoidAuthorizeResponse
{
"type": "object",
"example": {
"success": true,
"resultCode": 0,
"resultMessage": "Request ID: 5231719060426316203012",
"transactionId": "5231719060426316203012",
"gatewayOrderId": "A001"
},
"properties": {
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded."
},
"resultCode": {
"type": "string",
"description": "The result code of the request. \n\n0 indicates that the request succeeded, and the following values indicate that the request failed:\n - 1: The request is declined.\n - 7: The field format is not correct.\n - 10: Client connection has timed out.\n - 11: Host connection has timed out.\n - 12: Processor connection has timed out.\n - 13: Gateway server is busy.\n - 20: The card type is not supported.\n - 21: The merchant account information is invalid.\n - 22: A generic error occurred on the processor.\n - 40: The card type has not been set up yet.\n - 41: The limit for a single transaction is exceeded.\n - 42: Address checking failed.\n - 43: Card security code checking failed.\n - 44: Failed due to the gateway security setting.\n - 45: Fraud protection is declined.\n - 46: Address checking or card security code checking failed (for Authorize.net gateway only).\n - 47: The maximum amount is exceeded (for Authorize.net gateway only).\n - 48: The IP address is blocked by the gateway (for Authorize.net gateway only).\n - 49: Card security code checking failed (for Authorize.net gateway only).\n - 60: User authentication failed.\n - 61: The currency code is invalid.\n - 62: The transaction ID is invalid.\n - 63: The credit card number is invalid.\n - 64: The card expiration date is invalid.\n - 65: The transaction is duplicated.\n - 66: Credit transaction error.\n - 67: Void transaction error.\n - 90: A valid amount is required.\n - 91: The BA code is invalid.\n - 92: The account number is invalid.\n - 93: The ACH transaction is not accepted by the merchant.\n - 94: An error occurred for the ACH transaction.\n - 95: The version parameter is invalid.\n - 96: The transaction type is invalid.\n - 97: The transaction method is invalid.\n - 98: The bank account type is invalid.\n - 99: The authorization code is invalid.\n - 200: General transaction error.\n - 500: The transaction is queued for submission.\n - 999: Unknown error.\n - -1: An error occurred in gateway communication.\n - -2: Idempotency is not supported.\n - -3: Inquiry call is not supported.\n"
},
"resultMessage": {
"type": "string",
"description": "The corresponding request ID."
},
"transactionId": {
"type": "string",
"description": "The ID of the transaction."
},
"gatewayOrderId": {
"type": "string",
"description": "The order ID for the specific gateway.\n\nThe specified order ID will be used in transaction authorization. If you specify an empty value for this field, Zuora will generate an ID and you will have to associate this ID with your order ID by yourself if needed. It is recommended to specify an ID for this field.\n"
}
}
}
POSTWorkflowDefinitionImportRequest
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Task"
}
},
"linkages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Linkage"
}
},
"workflow": {
"$ref": "#/components/schemas/Workflow"
}
}
}
POSTorPUTCatalogGroupAddProductRatePlan
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the product rate plan.\n"
},
"grade": {
"type": "number",
"description": "The grade that is assigned for the product rate plan. The value of this field must be a positive integer. The greater the value, the higher the grade.\n\nA product rate plan to be added to a Grading catalog group must have one grade. You can specify a grade for a product rate plan in this request or update the product rate plan individually. \n"
}
}
}
],
"title": "productRatePlans",
"example": {
"id": "4028e5ab7f1b600c017f1b787d5d01cfX",
"grade": 3
}
}
PUTAccountEinvoiceProfile
{
"allOf": [
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable e-invoice for the account. All invoices generated from this account can be submitted to generate e-invoices when invoices meet the conditions: A business region must be created for the billing country contact, and it must be linked to a service provider. The account must be enabled to generate e-invoices. The invoice must be in the \"Posted\" status. "
},
"endpointId": {
"type": "string",
"description": "Buyer electronic address.Identifies the Buyer's electronic address to which the invoice is delivered.\n"
},
"businessName": {
"type": "string",
"maxLength": 255,
"description": "Legal Business Name. The full formal name by which the Buyer is registered with the relevant legal authority. "
},
"businessNumber": {
"type": "string",
"description": "Buyer legal registration identifier. An identifier issued by an official registrar that identifies the Buyer as a legal entity or person. GSTIN of buyer for India. "
},
"businessCategory": {
"enum": [
"B2B",
"B2C",
"B2G"
],
"type": "string",
"description": "The high-level category of the business.\n"
},
"endpointSchemeId": {
"type": "string",
"description": "Buyer electronic address identification scheme identifier. "
},
"taxRegisterNumber": {
"type": "string",
"description": "Buyer VAT identifier. The Buyer's VAT identifier (also known as Buyer VAT identification number).\n"
},
"businessNumberSchemeId": {
"type": "string",
"description": "Business Number Schema Id. The identification scheme identifier of the Buyer legal registration identifier. "
}
}
}
],
"title": "einvoiceProfile",
"description": "Container for profile information for this account.\n\n**Note**: This field is available only if you have the <a\nhref=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\"\ntarget=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
}
PUTAccountType
{
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Account name, up to 255 characters.\n"
},
"batch": {
"type": "string",
"description": "The alias name given to a batch. A string of 50 characters or\nless.\n\n**Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite\" target=\"_blank\">Performance Booster Elite</a> package.\n"
},
"crmId": {
"type": "string",
"description": "CRM account ID for the account, up to 100 characters.\n"
},
"notes": {
"type": "string",
"description": "A string of up to 65,535 characters.\n"
},
"autoPay": {
"type": "boolean",
"description": "Whether future payments are to be automatically billed when they are due. \n"
},
"tagging": {
"type": "string",
"description": ""
},
"taxInfo": {
"type": "object",
"properties": {
"VATId": {
"type": "string",
"description": "EU Value Added Tax ID. \n\n**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com).\n"
},
"companyCode": {
"type": "string",
"description": "Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara.\n\n**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). \n"
},
"exemptStatus": {
"type": "string",
"description": "Status of the account tax exemption. Requires Zuora Tax.\n\nRequired if you use Zuora Tax. This field is unavailable if Zuora Tax is not used.\n\nValues: `Yes`, `No`(default), `pendingVerification`. Note that the value will be set to `No` if no input.\n"
},
"exemptDescription": {
"type": "string",
"description": "Description of the tax exemption certificate that the customer holds. Requires Zuora Tax.\n"
},
"exemptCertificateId": {
"type": "string",
"description": "ID of the customer tax exemption certificate. Requires Zuora Tax.\n"
},
"exemptEffectiveDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption starts. Requires Zuora Tax.\n\nFormat: `yyyy-mm-dd`. Defaults to the current date.\n"
},
"exemptEntityUseCode": {
"type": "string",
"maxLength": 64,
"description": "A unique entity use code to apply exemptions in Avalara AvaTax.\n\nThis account-level field is required only when you choose Avalara as your tax engine. See [Exempt Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for more details.\n"
},
"exemptExpirationDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption expires. Requires Zuora Tax.\n\nFormat: `yyyy-mm-dd`. Defaults to the current date.\n"
},
"exemptCertificateType": {
"type": "string",
"description": "Type of tax exemption certificate that the customer holds. Requires Zuora Tax.\n"
},
"exemptIssuingJurisdiction": {
"type": "string",
"description": "Jurisdiction in which the customer tax exemption certificate was issued.\n"
}
},
"description": "Container for tax exempt information, used to establish the tax exempt status of a customer account.\n"
},
"parentId": {
"type": "string",
"description": "Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\" target=\"_blank\">Customer Hierarchy</a> enabled."
},
"salesRep": {
"type": "string",
"description": "The name of the sales representative associated with this account, if applicable. Maximum of 50 characters."
},
"paymentTerm": {
"type": "string",
"description": "Payment terms for this account. Possible values are `Due Upon Receipt`, `Net 30`, `Net 60`, `Net 90`."
},
"billCycleDay": {
"type": "integer",
"maxLength": 2,
"description": "Sets the bill cycle day (BCD) for the charge. The BCD determines\nwhich day of the month the customer is billed. Values: Any activated system-defined bill cycle day （`1`-`31`）\n"
},
"billToContact": {
"$ref": "#/components/schemas/PUTAccountTypeBillToContact"
},
"profileNumber": {
"type": "string",
"description": "The number of the communication profile that this account is linked to.\n\nYou can provide either or both of the `communicationProfileId` and `profileNumber` fields.\n\nIf both are provided, the request will fail if they do not refer to the same communication profile.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the billing document sequence set to assign to the customer account. \n\nThe billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set.\n\nIf a customer account has no assigned billing document sequence set, billing documents generated for this account adopt the prefix and starting document number from the default sequence set.\n"
},
"soldToContact": {
"$ref": "#/components/schemas/PUTAccountTypeSoldToContact"
},
"partnerAccount": {
"type": "boolean",
"default": false,
"description": "Whether the customer account is a partner, distributor, or reseller. \n\n\nYou can set this field to `true` if you have business with distributors or resellers, or operating in B2B model to manage numerous subscriptions through concurrent API requests. After this field is set to `true`, the calculation of account metrics is performed asynchronously during operations such as subscription creation, order changes, invoice generation, and payments.\n\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account\" target=\"_blank\">Reseller Account</a> feature enabled.\n"
},
"paymentGateway": {
"type": "string",
"description": "The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.\n"
},
"einvoiceProfile": {
"$ref": "#/components/schemas/PUTAccountEinvoiceProfile"
},
"invoiceTemplateId": {
"type": "string",
"description": "Invoice template ID, configured in Billing Settings in the Zuora UI.\n"
},
"debitMemoTemplateId": {
"type": "string",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThe unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "The purchase order number provided by your customer for services, products, or both purchased."
},
"creditMemoTemplateId": {
"type": "string",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThe unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.\n"
},
"communicationProfileId": {
"type": "string",
"description": "The ID of the communication profile that this account is linked to.\n\nYou can provide either or both of the `communicationProfileId` and `profileNumber` fields.\n\nIf both are provided, the request will fail if they do not refer to the same communication profile.\n"
},
"customerServiceRepName": {
"type": "string",
"maxLength": 50,
"description": "Name of the account’s customer service representative, if applicable.\n"
},
"defaultPaymentMethodId": {
"type": "string",
"maxLength": 64,
"description": "ID of the default payment method for the account.\n\nValues: a valid ID for an existing payment method.\n"
},
"additionalEmailAddresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of additional email addresses to receive email notifications. Use commas to separate email addresses.\n"
},
"invoiceDeliveryPrefsEmail": {
"type": "boolean",
"description": "Whether the customer wants to receive invoices through email. \n\nThe default value is `false`.\n"
},
"invoiceDeliveryPrefsPrint": {
"type": "boolean",
"description": "Whether the customer wants to receive printed invoices, such as through postal mail.\n\nThe default value is `false`.\n"
}
}
},
{
"$ref": "#/components/schemas/AccountObjectNSFields"
},
{
"$ref": "#/components/schemas/AccountObjectCustomFields"
}
],
"example": {
"paymentGateway": "TestGateway",
"einvoiceProfile": {
"enabled": true,
"endpointId": "8992",
"businessName": "legal business name",
"businessNumber": "20002039",
"endpointSchemeId": "88",
"taxRegisterNumber": "TAX393999",
"businessNumberSchemeId": "88"
},
"purchaseOrderNumber": "PO0001",
"customerServiceRepName": "CSR0001",
"additionalEmailAddresses": [
"contact3@example.com",
"contact4@example.com"
]
}
}
PUTAccountTypeBillToContact
{
"allOf": [
{
"type": "object",
"required": [
"firstName",
"lastName"
],
"properties": {
"fax": {
"type": "string",
"description": "Fax phone number, 40 characters or less.\n"
},
"city": {
"type": "string",
"description": "City, 40 characters or less.\n"
},
"state": {
"type": "string",
"description": "State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided.\n"
},
"county": {
"type": "string",
"description": "County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax.\n"
},
"country": {
"type": "string",
"description": "Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.\n"
},
"zipCode": {
"type": "string",
"description": "Zip code, 20 characters or less.\n"
},
"address1": {
"type": "string",
"description": "First address line, 255 characters or less.\n"
},
"address2": {
"type": "string",
"description": "Second address line, 255 characters or less.\n"
},
"lastName": {
"type": "string",
"description": "Last name, 100 characters or less.\n"
},
"nickname": {
"type": "string",
"description": "Nickname for this contact\n"
},
"firstName": {
"type": "string",
"description": "First name, 100 characters or less.\n"
},
"homePhone": {
"type": "string",
"description": "Home phone number, 40 characters or less.\n"
},
"taxRegion": {
"type": "string",
"description": "If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n"
},
"workEmail": {
"type": "string",
"description": "Work email address, 80 characters or less.\n"
},
"workPhone": {
"type": "string",
"description": "Work phone number, 40 characters or less.\n"
},
"otherPhone": {
"type": "string",
"description": "Other phone number, 40 characters or less.\n"
},
"mobilePhone": {
"type": "string",
"description": "Mobile phone number, 40 characters or less.\n"
},
"personalEmail": {
"type": "string",
"description": "Personal email address, 80 characters or less.\n"
},
"otherPhoneType": {
"type": "string",
"description": "Possible values are: `Work`, `Mobile`, `Home`, `Other`.\n"
}
}
},
{
"$ref": "#/components/schemas/ContactObjectCustomFields"
}
],
"title": "Contact",
"description": "Container for bill-to contact information for this account.\n"
}
PUTAccountTypeSoldToContact
{
"allOf": [
{
"type": "object",
"required": [
"firstName",
"lastName"
],
"properties": {
"fax": {
"type": "string",
"description": "Fax phone number, 40 characters or less.\n"
},
"city": {
"type": "string",
"description": "City, 40 characters or less.\n"
},
"state": {
"type": "string",
"description": "State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided.\n"
},
"county": {
"type": "string",
"description": "County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax.\n"
},
"country": {
"type": "string",
"description": "Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.\n"
},
"zipCode": {
"type": "string",
"description": "Zip code, 20 characters or less.\n"
},
"address1": {
"type": "string",
"description": "First address line, 255 characters or less.\n"
},
"address2": {
"type": "string",
"description": "Second address line, 255 characters or less.\n"
},
"lastName": {
"type": "string",
"description": "Last name, 100 characters or less.\n"
},
"nickname": {
"type": "string",
"description": "Nickname for this contact\n"
},
"firstName": {
"type": "string",
"description": "First name, 100 characters or less.\n"
},
"homePhone": {
"type": "string",
"description": "Home phone number, 40 characters or less.\n"
},
"taxRegion": {
"type": "string",
"description": "If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n"
},
"workEmail": {
"type": "string",
"description": "Work email address, 80 characters or less.\n"
},
"workPhone": {
"type": "string",
"description": "Work phone number, 40 characters or less.\n"
},
"otherPhone": {
"type": "string",
"description": "Other phone number, 40 characters or less.\n"
},
"mobilePhone": {
"type": "string",
"description": "Mobile phone number, 40 characters or less.\n"
},
"personalEmail": {
"type": "string",
"description": "Personal email address, 80 characters or less.\n"
},
"otherPhoneType": {
"type": "string",
"description": "Possible values are: `Work`, `Mobile`, `Home`, `Other`.\n"
}
}
},
{
"$ref": "#/components/schemas/ContactObjectCustomFields"
}
],
"title": "Contact",
"description": "Container for optional sold-to contact.\n"
}
PUTAccountingCodeType
{
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the accounting code.\n\nAccounting code name must be unique. Maximum of 100 characters.\n"
},
"type": {
"enum": [
"AccountsReceivable",
"On-Account Receivable",
"Cash",
"OtherAssets",
"CustomerCashOnAccount",
"DeferredRevenue",
"SalesTaxPayable",
"OtherLiabilities",
"SalesRevenue",
"SalesDiscounts",
"OtherRevenue",
"OtherEquity",
"BadDebt",
"OtherExpenses"
],
"type": "string",
"description": "Accounting code type. You cannot change the type of an accounting code from `AccountsReceivable` to a different type. \n\nNote that `On-Account Receivable` is only available if you enable the Invoice Settlement feature. \n"
},
"notes": {
"type": "string",
"description": "Maximum of 2,000 characters.\n"
},
"glAccountName": {
"type": "string",
"description": "Name of the account in your general ledger.\n\nField only available if you have Zuora Finance enabled. Maximum of 255 characters.\n"
},
"glAccountNumber": {
"type": "string",
"description": "Account number in your general ledger.\n\nField only available if you have Zuora Finance enabled. Maximum of 255 characters.\n"
}
}
},
{
"$ref": "#/components/schemas/AccountingCodeObjectCustomFields"
}
],
"example": {
"name": "CASH",
"type": "Cash"
}
}
PUTAccountingPeriodType
{
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the accounting period.\n\nAccounting period name must be unique. Maximum of 100 characters.\n"
},
"notes": {
"type": "string",
"description": "Notes about the accounting period.\n\nMaximum of 255 characters.\n"
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date of the accounting period in yyyy-mm-dd format, for example, \"2016-02-19\".\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the accounting period in yyyy-mm-dd format, for example, \"2016-02-19\".\n"
},
"fiscalYear": {
"type": "string",
"description": "Fiscal year of the accounting period in yyyy format, for example, \"2016\".\n"
},
"fiscal_quarter": {
"type": "integer",
"format": "int64",
"description": ""
}
}
},
{
"$ref": "#/components/schemas/AccountingPeriodObjectCustomFields"
}
],
"example": {
"name": "Jan 2016",
"endDate": "2016-01-31",
"startDate": "2016-01-01",
"fiscalYear": 2016
}
}
PUTAttachmentType
{
"type": "object",
"example": {
"fileName": "Image123.png",
"description": "Updated image"
},
"properties": {
"fileName": {
"type": "string",
"description": "File name of the attachment. The value should not contain the file extension. Only the file name without the extension can be edited.\n"
},
"description": {
"type": "string",
"description": "Description of the attachment.\n"
}
}
}
PUTBasicSummaryJournalEntryType
{
"allOf": [
{
"type": "object",
"properties": {
"notes": {
"type": "string",
"description": "Additional information about this record.\n\n***Character limit:*** 2,000\n"
},
"journalEntryItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTJournalEntryItemType"
},
"description": "Key name that represents the list of journal entry items.\n"
},
"transferredToAccounting": {
"enum": [
"No",
"Processing",
"Yes",
"Error",
"Ignore"
],
"type": "string",
"description": "Status shows whether the journal entry has been transferred to an accounting system. \n\nThis field cannot be changed after the summary journal entry has been canceled.\n\n**Note:** The Zuora Finance ***Override Transferred to Accounting*** permission is required to change `transferredToAccounting` from `Yes` to any other value.\n"
}
}
},
{
"$ref": "#/components/schemas/JournalEntryObjectCustomFields"
}
],
"example": {
"notes": "Transfer to accounting system",
"journalEntryItems": [
{
"type": "Credit",
"accountingCodeName": "Accounts Receivable"
},
{
"type": "Debit",
"accountingCodeName": ""
}
],
"transferredToAccounting": "Yes"
}
}
PUTBatchDebitMemosRequest
{
"type": "object",
"example": {
"debitMemos": [
{
"id": "402890d25f9f083f015f9f28041d0008",
"dueDate": "2017-12-28"
},
{
"id": "402890555a87d7f5015a892f2ba10057X",
"dueDate": "2017-12-20"
}
]
},
"properties": {
"debitMemos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchDebitMemoType"
},
"description": "Container for debit memo update details.\n"
}
}
}
PUTBulkCreditMemosRequestType
{
"allOf": [
{
"type": "object",
"properties": {
"memos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTCreditMemosWithIdType"
},
"maxItems": 50,
"description": "The container for a list of credit memos. The maximum number of credit memos is 50.\n"
}
}
}
],
"example": {
"memos": [
{
"id": "402890555b797b57015b7986fc1a001f",
"items": [
{
"id": "402890555b797b57015b7986fc1a001cX",
"amount": 1,
"comment": "This is comment!",
"skuName": "SKU-1",
"quantity": 1,
"taxItems": [
{
"id": "402890555b797b57015b7986fc3c001dX",
"amount": 0.03,
"taxCode": null,
"taxDate": "2016-11-30",
"taxName": "STATE TAX1",
"taxRate": 0.0625,
"taxRateType": "Percentage",
"jurisdiction": "CALIFORNIA",
"locationCode": "06",
"taxExemptAmount": 0,
"taxCodeDescription": "This is tax code description!",
"taxRateDescription": "This is tax rate description!"
}
],
"unitOfMeasure": "Test_UOM",
"serviceEndDate": "2016-11-30",
"serviceStartDate": "2016-11-01"
},
{
"id": "402890555b797b57015b7986fc41001eX",
"amount": 2,
"comment": "This is comment!",
"skuName": "SKU-2",
"taxItems": [],
"unitOfMeasure": "Test_UOM",
"serviceEndDate": "2016-11-30",
"serviceStartDate": "2016-11-01"
}
],
"comment": "new comment",
"reasonCode": "Correcting invoice error",
"effectiveDate": "2017-04-17",
"autoApplyUponPosting": false,
"excludeFromAutoApplyRules": false
}
]
}
}
PUTBulkDebitMemosRequestType
{
"allOf": [
{
"type": "object",
"properties": {
"memos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTDebitMemoWithIdType"
},
"title": "memos",
"maxItems": 50,
"description": "The container for a list of debit memos. The maximum number of debit memos is 50.\n"
}
}
}
],
"example": {
"memos": [
{
"id": "4028905f5a890526015a8db30954007a",
"items": [
{
"id": "402890555b797b57015b7986fc1a001cX",
"amount": 1,
"comment": "This is comment!",
"skuName": "SKU-1",
"quantity": 1,
"taxItems": [
{
"id": "402890555b797b57015b7986fc3c001dX",
"amount": 0.03,
"taxCode": null,
"taxDate": "2016-11-30",
"taxName": "STATE TAX1",
"taxRate": 0.0625,
"taxRateType": "Percentage",
"jurisdiction": "CALIFORNIA",
"locationCode": "06",
"taxExemptAmount": 0,
"taxCodeDescription": "This is tax code description!",
"taxRateDescription": "This is tax rate description!"
}
],
"unitOfMeasure": "Test_UOM",
"serviceEndDate": "2016-11-30",
"serviceStartDate": "2016-11-01"
},
{
"id": "402890555b797b57015b7986fc41001eX",
"amount": 2,
"comment": "This is comment!",
"skuName": "SKU-2",
"taxItems": [
{
"id": "402890555b797b57015b7986fc4c001fX",
"amount": 0.06,
"taxCode": null,
"taxDate": "2016-11-30",
"taxName": "STATE TAX2",
"taxRate": 0.0625,
"taxRateType": "Percentage",
"jurisdiction": "CALIFORNIA",
"locationCode": "06",
"taxExemptAmount": 0,
"taxCodeDescription": "This is tax code description!",
"taxRateDescription": "This is tax rate description!"
}
],
"unitOfMeasure": "Test_UOM",
"serviceEndDate": "2016-11-30",
"serviceStartDate": "2016-11-01"
}
],
"autoPay": true,
"comment": "new comment",
"dueDate": "2017-05-20",
"reasonCode": "Correcting invoice error",
"effectiveDate": "2017-04-17"
}
]
}
}
PUTBulkProductChargeDefinitionRequest
{
"type": "object",
"properties": {
"uom": {
"type": "string",
"nullable": true,
"description": "Describes the unit of measure (UOM) configured in **Settings > Billing**.\n\n**Values**: `Each`, `License`, `Seat`, or `null`\n"
},
"term": {
"type": "number",
"nullable": true,
"description": "The number of periods of a termed subscription that is eligible for this charge definition. This field is applicable when the `termType` field is set to `TERMED`, \nand is to be used together with the `termPeriodType` field.\n"
},
"prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTProductChargeDefinitionPricing"
},
"description": "Container for the new prices to override the existing prices of the product charge definition.\n"
},
"taxCode": {
"type": "string",
"maxLength": 64,
"description": "Specifies the tax code for taxation rules. This field is equired when the `Taxable` field is set to `True`.\n\n**Note**: This value affects the tax calculation of the charge.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive",
null
],
"type": "string",
"nullable": true,
"description": "Determines how to define taxation for the charge. This field is equired when the `taxable` field is set to `true`.\n\n**Note**: This value affects the tax calculation of the charge.\n"
},
"taxable": {
"type": "boolean",
"description": "Determines whether the charge definition is taxable. When this field is set to `true`, the `taxMode` and `taxCode` fields are required.\n\n**Character limit**: 5\n\n**Values**: `true`, `false`\n\n**Note**: This value affects the tax calculation of the charge.\n"
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN",
null
],
"type": "string",
"nullable": true,
"description": "The type of the subscription that is eligible for this charge definition.\n"
},
"chargeModel": {
"enum": [
"DiscountFixedAmount",
"DiscountPercentage",
"FlatFee",
"PerUnit",
"Tiered",
"Volume",
"Delivery"
],
"type": "string",
"description": "Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n"
},
"billingPeriod": {
"type": "string",
"description": "The override value of the billingPeriod for the product charge definition.\n"
},
"billingTiming": {
"enum": [
"IN_ADVANCE",
"IN_ARREARS"
],
"type": "string",
"description": "The override value of the billingTiming for the product charge definition.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year"
],
"type": "string",
"description": "The list price base. \n\nThis field is applicable only for recurring charges.\n\n**Note**: The `Per_Year` enum value is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n"
},
"termPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week",
null
],
"type": "string",
"nullable": true,
"description": "Specifies the period type for the subscription term that is eligible for this charge definition.\n"
},
"defaultQuantity": {
"type": "number",
"description": "The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n"
},
"specificBillingPeriod": {
"type": "number",
"nullable": true,
"description": "The override value of the specificBillingPeriod for the product charge definition.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"nullable": true,
"description": "The number of months for the list price base of the charge definition. \nThe field is `null` if the `listPriceBase` field is not set to `Per_Specific_Months`.\n"
},
"productChargeDefinitionKey": {
"type": "string",
"description": "The unique number or ID of the product charge definition to be updated.\n"
}
}
}
PUTCancelPaymentScheduleRequest
{
"type": "object",
"required": [
"cancelDate"
],
"properties": {
"cancelDate": {
"type": "string",
"format": "date",
"description": "Specifies when the payment schedule will be canceled.\n"
}
}
}
PUTCatalogGroup
{
"allOf": [
{
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTorPUTCatalogGroupAddProductRatePlan"
},
"title": "add",
"description": "The list of product rate plans to be added to the catalog group.\n"
},
"name": {
"type": "string",
"description": "The unique name of the catalog group.\n"
},
"remove": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTCatalogGroupRemoveProductRatePlan"
},
"description": "The list of product rate plans to be removed from the catalog group.\n"
},
"description": {
"type": "string",
"description": "The description of the catalog group.\n"
}
}
}
],
"example": {
"add": [
{
"id": "4028e5ab7f1b600c017f1b787d5d01cfX",
"grade": 3
},
{
"id": "4028e5ab7f1b600c017f1b787d5d01acX",
"grade": 2
}
],
"name": "name",
"remove": [
{
"id": "4028e5ab7f1b600c017f1b787d5d01cfX"
},
{
"id": "4028e5ab7f1b600c017f1b787d5d01acX"
}
],
"description": "description"
}
}
PUTCatalogGroupRemoveProductRatePlan
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the product rate plan to be removed from the catalog group.\n"
}
}
}
],
"title": "remove",
"example": {
"id": "4028e5ab7f1b600c017f1b787d5d01cfX"
}
}
PUTContactType
{
"allOf": [
{
"type": "object",
"properties": {
"fax": {
"type": "string",
"maxLength": 40,
"description": "The contact's fax number.\n"
},
"city": {
"type": "string",
"maxLength": 40,
"description": "The city of the contact's address.\n"
},
"state": {
"type": "string",
"maxLength": 40,
"description": "The state or province of the contact's address.\n"
},
"county": {
"type": "string",
"maxLength": 32,
"description": "The county. May optionally be used by Zuora Tax to calculate county tax.\n"
},
"country": {
"type": "string",
"maxLength": 64,
"description": "The country of the contact's address.\n"
},
"zipCode": {
"type": "string",
"maxLength": 20,
"description": "The zip code for the contact's address.\n"
},
"address1": {
"type": "string",
"maxLength": 255,
"description": "The first line of the contact's address, which is often a street address or business name.\n"
},
"address2": {
"type": "string",
"maxLength": 255,
"description": "The second line of the contact's address.\n"
},
"lastName": {
"type": "string",
"maxLength": 100,
"description": "The contact's last name.\n"
},
"nickname": {
"type": "string",
"maxLength": 100,
"description": "A nickname for the contact.\n"
},
"firstName": {
"type": "string",
"maxLength": 100,
"description": "The contact's first name.\n"
},
"homePhone": {
"type": "string",
"maxLength": 40,
"description": "The contact's home phone number.\n"
},
"taxRegion": {
"type": "string",
"maxLength": 32,
"description": "If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n"
},
"workEmail": {
"type": "string",
"maxLength": 74,
"description": "The contact's business email address.\n"
},
"workPhone": {
"type": "string",
"maxLength": 40,
"description": "The contact's business phone number.\n"
},
"otherPhone": {
"type": "string",
"maxLength": 40,
"description": "An additional phone number for the contact.\n"
},
"mobilePhone": {
"type": "string",
"maxLength": 100,
"description": "The mobile phone number of the contact.\n"
},
"personalEmail": {
"type": "string",
"maxLength": 74,
"description": "The contact's personal email address.\n"
},
"otherPhoneType": {
"enum": [
"Work",
"Mobile",
"Home",
"Other"
],
"type": "string",
"description": "The type of the additional phone number.\n"
},
"contactDescription": {
"type": "string",
"maxLength": 100,
"description": "A description for the contact.\n"
}
}
},
{
"$ref": "#/components/schemas/ContactObjectCustomFields"
}
],
"example": {
"city": "Mumbai",
"zipCode": 123134,
"address1": "new Address",
"mobilePhone": 123213,
"contactDescription": "This is the new Description"
}
}
PUTCreditMemoItemType
{
"allOf": [
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"minLength": 32,
"description": "The ID of the credit memo item.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax\n"
},
"comment": {
"type": "string",
"description": "Comments about the credit memo item.\n"
},
"skuName": {
"type": "string",
"description": "The name of the SKU.\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "The number of units for the credit memo item.\n"
},
"taxItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutCreditMemoTaxItemType"
},
"description": "Container for credit memo taxation items.\n"
},
"unitOfMeasure": {
"type": "string",
"description": "The definable unit that you measure when determining charges.\n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The service end date of the credit memo item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The service start date of the credit memo item.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"onAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n"
}
},
"description": "Container for the finance information related to the credit memo item.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude the credit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/CreditMemoItemObjectCustomFields"
}
],
"title": "items"
}
PUTCreditMemoType
{
"allOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTCreditMemoItemType"
},
"description": "Container for credit memo items.\n"
},
"comment": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "Comments about the credit memo.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the credit memo takes effect.\n"
},
"autoApplyUponPosting": {
"type": "boolean",
"description": "Whether the credit memo automatically applies to the invoice upon posting.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the credit memo is transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"excludeFromAutoApplyRules": {
"type": "boolean",
"description": "Whether the credit memo is excluded from the rule of automatically applying unapplied credit memos to invoices and debit memos during payment runs. If you set this field to `true`, a payment run does not pick up this credit memo or apply it to other invoices or debit memos.\n"
}
}
},
{
"$ref": "#/components/schemas/CreditMemoObjectNSFields"
},
{
"$ref": "#/components/schemas/CreditMemoObjectCustomFields"
}
],
"example": {
"items": [
{
"id": "402890555b797b57015b7986fc1a001c",
"amount": 1,
"comment": "This is comment!",
"skuName": "SKU-1",
"quantity": 1,
"taxItems": [
{
"id": "402890555b797b57015b7986fc3c001d",
"amount": 0.03,
"taxCode": null,
"taxDate": "2016-11-30",
"taxName": "STATE TAX1",
"taxRate": 0.0625,
"taxRateType": "Percentage",
"jurisdiction": "CALIFORNIA",
"locationCode": "06",
"taxExemptAmount": 0,
"taxCodeDescription": "This is tax code description!",
"taxRateDescription": "This is tax rate description!"
}
],
"unitOfMeasure": "Test_UOM",
"serviceEndDate": "2016-11-30",
"serviceStartDate": "2016-11-01"
},
{
"id": "402890555b797b57015b7986fc41001e",
"amount": 2,
"comment": "This is comment!",
"skuName": "SKU-2",
"taxItems": [
{
"id": "402890555b797b57015b7986fc4c001f",
"amount": 0.06,
"taxCode": null,
"taxDate": "2016-11-30",
"taxName": "STATE TAX2",
"taxRate": 0.0625,
"taxRateType": "Percentage",
"jurisdiction": "CALIFORNIA",
"locationCode": "06",
"taxExemptAmount": 0,
"taxCodeDescription": "This is tax code description!",
"taxRateDescription": "This is tax rate description!"
}
],
"unitOfMeasure": "Test_UOM",
"serviceEndDate": "2016-11-30",
"serviceStartDate": "2016-11-01"
}
],
"comment": "new comment",
"reasonCode": "Correcting invoice error",
"effectiveDate": "2017-04-17",
"autoApplyUponPosting": false,
"excludeFromAutoApplyRules": false
}
}
PUTCreditMemoWriteOff
{
"allOf": [
{
"type": "object",
"properties": {
"comment": {
"type": "string",
"description": "Comments about the debit memo.\n"
},
"memoDate": {
"type": "string",
"format": "date",
"description": "The creation date of the debit memo and the effective date of the credit memo. Credit memos are applied to the corresponding debit memos on `memoDate`. By default, `memoDate` is set to the current date.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty. The default value is `Write-off`.\n"
}
}
},
{
"$ref": "#/components/schemas/DebitMemoObjectCustomFieldsCMWriteOff"
}
],
"example": {
"comment": "Comments about the debit memo.",
"memoDate": "2022-05-05",
"DMCustomField__c": "Custom fields"
}
}
PUTCreditMemoWriteOffResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"debitMemo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the created debit memo.\n"
}
},
"description": "Container for the credit memo that is automatically created.\n"
}
}
}
PUTCreditMemosWithIdType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the credit memo.\n"
}
}
},
{
"$ref": "#/components/schemas/PUTCreditMemoType"
}
],
"title": "memos"
}
PUTDebitMemoItemType
{
"allOf": [
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"minLength": 32,
"description": "The ID of the debit memo item.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax.\n"
},
"comment": {
"type": "string",
"description": "Comments about the debit memo item.\n"
},
"skuName": {
"type": "string",
"description": "The name of the SKU.\n"
},
"quantity": {
"type": "number",
"format": "double",
"description": "The number of units for the debit memo item.\n"
},
"taxItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutDebitMemoTaxItemType"
},
"description": "Container for debit memo taxation items.\n"
},
"unitOfMeasure": {
"type": "string",
"description": "The definable unit that you measure when determining charges.\n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The service end date of the debit memo item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The service start date of the debit memo item. \n"
},
"financeInformation": {
"type": "object",
"properties": {
"revenueRecognitionRuleName": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n"
}
},
"description": "Container for the finance information related to the debit memo item.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude the debit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/DebitMemoItemObjectCustomFields"
}
],
"title": "items"
}
PUTDebitMemoType
{
"allOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTDebitMemoItemType"
},
"description": "Container for debit memo items.\n"
},
"autoPay": {
"type": "boolean",
"description": "Whether debit memos are automatically picked up for processing in the corresponding payment run. \n\nBy default, debit memos are automatically picked up for processing in the corresponding payment run.\n"
},
"comment": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "Comments about the debit memo.\n"
},
"dueDate": {
"type": "string",
"format": "date",
"description": "The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the debit memo takes effect.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the debit memo is transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
}
}
},
{
"$ref": "#/components/schemas/DebitMemoObjectNSFields"
},
{
"$ref": "#/components/schemas/DebitMemoObjectCustomFields"
}
],
"example": {
"items": [
{
"id": "402890555b797b57015b7986fc1a001cX",
"amount": 1,
"comment": "This is comment!",
"skuName": "SKU-1",
"quantity": 1,
"taxItems": [
{
"id": "402890555b797b57015b7986fc3c001dX",
"amount": 0.03,
"taxCode": null,
"taxDate": "2016-11-30",
"taxName": "STATE TAX1",
"taxRate": 0.0625,
"taxRateType": "Percentage",
"jurisdiction": "CALIFORNIA",
"locationCode": "06",
"taxExemptAmount": 0,
"taxCodeDescription": "This is tax code description!",
"taxRateDescription": "This is tax rate description!"
}
],
"unitOfMeasure": "Test_UOM",
"serviceEndDate": "2016-11-30",
"serviceStartDate": "2016-11-01"
},
{
"id": "402890555b797b57015b7986fc41001eX",
"amount": 2,
"comment": "This is comment!",
"skuName": "SKU-2",
"taxItems": [
{
"id": "402890555b797b57015b7986fc4c001fX",
"amount": 0.06,
"taxCode": null,
"taxDate": "2016-11-30",
"taxName": "STATE TAX2",
"taxRate": 0.0625,
"taxRateType": "Percentage",
"jurisdiction": "CALIFORNIA",
"locationCode": "06",
"taxExemptAmount": 0,
"taxCodeDescription": "This is tax code description!",
"taxRateDescription": "This is tax rate description!"
}
],
"unitOfMeasure": "Test_UOM",
"serviceEndDate": "2016-11-30",
"serviceStartDate": "2016-11-01"
}
],
"autoPay": true,
"comment": "new comment",
"dueDate": "2017-05-20",
"reasonCode": "Correcting invoice error",
"effectiveDate": "2017-04-17"
}
}
PUTDebitMemoWithIdType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the debit memo.\n"
}
}
},
{
"$ref": "#/components/schemas/PUTDebitMemoType"
}
]
}
PUTDeleteSubscriptionResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request is processed successfully."
}
}
}
PUTJournalEntryItemType
{
"allOf": [
{
"type": "object",
"required": [
"accountingCodeName",
"type"
],
"properties": {
"type": {
"enum": [
"Credit",
"Debit"
],
"type": "string",
"description": "Type of journal entry item. "
},
"accountingCodeName": {
"type": "string",
"description": "Name of the accounting code.\n\nIf the Journal Entry Item has a blank accounting code, enter the empty string.\n"
},
"accountingCodeType": {
"enum": [
"AccountsReceivable",
"On-Account Receivable",
"Cash",
"OtherAssets",
"CustomerCashOnAccount",
"DeferredRevenue",
"SalesTaxPayable",
"OtherLiabilities",
"SalesRevenue",
"SalesDiscounts",
"OtherRevenue",
"OtherEquity",
"BadDebt",
"OtherExpenses"
],
"type": "string",
"description": "Accounting code type.\n\nNote that `On-Account Receivable` is only available if you enable the Invoice Settlement feature. \n"
}
}
},
{
"$ref": "#/components/schemas/JournalEntryItemObjectCustomFields"
}
],
"title": "journalEntryItems"
}
PUTOrderActionTriggerDatesRequestType
{
"type": "object",
"example": {
"subscriptions": [
{
"orderActions": [
{
"charges": [
{
"chargeNumber": "C-0000001",
"specificTriggerDate": "2016-09-01"
}
],
"sequence": 0,
"triggerDates": [
{
"name": "CustomerAcceptance",
"triggerDate": "2016-09-01"
}
]
}
],
"subscriptionNumber": "A-S00000009"
}
]
},
"properties": {
"subscriptions": {
"type": "array",
"items": {
"type": "object",
"required": [
"subscriptionNumber"
],
"properties": {
"orderActions": {
"type": "array",
"items": {
"type": "object",
"required": [
"sequence"
],
"properties": {
"charges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"chargeNumber": {
"type": "string",
"description": "Charge number of the charge which needs the triggering date to be provided. The charge's `triggerEvent` must have been set as `SpecificDate`."
},
"specificTriggerDate": {
"type": "string",
"format": "date",
"description": "Date in YYYY-MM-DD format. The specific trigger date you are to set for the charge."
}
}
}
},
"sequence": {
"type": "integer",
"description": "Identifies which order action will have its triggering dates updated. \n"
},
"triggerDates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"enum": [
"ServiceActivation",
"CustomerAcceptance"
],
"type": "string",
"description": "Name of the trigger date of the order action."
},
"triggerDate": {
"type": "string",
"format": "date",
"description": "Trigger date in YYYY-MM-DD format. The date you are to set as the service activation date or the customer acceptance date.\n"
}
}
},
"description": "Container for the service activation and customer acceptance dates of the order action."
}
}
}
},
"subscriptionNumber": {
"type": "string",
"maxLength": 100,
"description": "Subscription number of a subscription in the `Pending` order for which you are to update the triggering dates. For example, A-S00000001.\n"
}
}
}
}
}
}
PUTOrderActionsRequestType
{
"type": "object",
"example": {
"changeReason": "string",
"customFields": {
"PICKLIST_CF__c": "option_1"
}
},
"properties": {
"orderAction": {
"$ref": "#/components/schemas/OrderActionCommon"
}
}
}
PUTOrderPatchRequestType
{
"type": "object",
"example": {
"customFields": {
"order_cf__c": "order custom fields"
},
"subscriptions": [
{
"orderActions": [
{
"sequence": 0,
"customFields": {
"order_action_cf__c": "Order action custom fields",
"order_action_undex__c": "Order action custom fields"
}
}
],
"subscriptionNumber": "S-00005"
}
]
},
"properties": {
"customFields": {
"$ref": "#/components/schemas/OrderObjectCustomFields"
},
"subscriptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"orderActions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sequence": {
"type": "integer",
"description": "The sequence number of the order action in the order. You can provide either the `sequence` or the `orderActionId` field to specify which order action to update. You cannot use then both at the same time.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderActionObjectCustomFields"
},
"orderActionId": {
"type": "string",
"description": "The Id of the order action in the order. You can provide either the `sequence` or the `orderActionId` field to specify which order action to update. You cannot use then both at the same time.\n"
}
}
}
},
"subscriptionNumber": {
"type": "string"
}
}
}
}
}
}
PUTOrderRequestType
{
"type": "object",
"example": {
"orderDate": "2017-01-01",
"description": "This is a description for the Order.",
"orderNumber": "OM-00001",
"subscriptions": [
{
"orderActions": [
{
"type": "CreateSubscription",
"triggerDates": [
{
"name": "ContractEffective",
"triggerDate": "2017-01-01"
}
],
"createSubscription": {
"terms": {
"autoRenew": true,
"initialTerm": {
"period": 12,
"termType": "TERMED",
"startDate": "2017-01-01",
"periodType": "Month"
},
"renewalTerms": [
{
"period": 12,
"periodType": "Month"
}
],
"renewalSetting": "RENEW_WITH_SPECIFIC_TERM"
},
"paymentTerm": "Net 30",
"sequenceSetId": "6abcc30846de11e990900242ac1f0003",
"billToContactId": "efbff07e6290dfb8016291003bd00dda",
"soldToContactId": "efbff07e6290dfb8016291003bd00ddb",
"invoiceTemplateId": "2c9081a03c638994013c63978baf002b",
"subscriptionNumber": "SM-00001",
"subscribeToRatePlans": [
{
"productRatePlanId": "efbff07e6290dfb8016291003bd00dda"
}
]
}
}
]
},
{
"orderActions": [
{
"type": "CreateSubscription",
"triggerDates": [
{
"name": "ServiceActivation",
"triggerDate": "2017-02-01"
}
],
"createSubscription": {
"terms": {
"autoRenew": true,
"initialTerm": {
"period": 12,
"termType": "TERMED",
"startDate": "2017-02-01",
"periodType": "Month"
},
"renewalTerms": [
{
"period": 12,
"periodType": "Month"
}
],
"renewalSetting": "RENEW_WITH_SPECIFIC_TERM"
},
"subscriptionNumber": "SM-00002",
"subscribeToRatePlans": [
{
"productRatePlanId": "efbff07e6290dfb8016291003bd00dda"
}
]
}
}
]
},
{
"orderActions": [
{
"type": "CreateSubscription",
"triggerDates": [
{
"name": "ServiceActivation",
"triggerDate": "2017-03-01"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2017-04-01"
}
],
"createSubscription": {
"terms": {
"autoRenew": true,
"initialTerm": {
"period": 12,
"termType": "TERMED",
"startDate": "2017-01-01",
"periodType": "Month"
},
"renewalTerms": [
{
"period": 12,
"periodType": "Month"
}
],
"renewalSetting": "RENEW_WITH_SPECIFIC_TERM"
},
"subscriptionNumber": "SM-00003",
"subscribeToRatePlans": [
{
"productRatePlanId": "efbff07e6290dfb80162910024c80dd5"
}
]
}
}
]
},
{
"orderActions": [
{
"type": "CreateSubscription",
"triggerDates": [
{
"name": "ServiceActivation",
"triggerDate": "2017-03-01"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2017-04-01"
}
],
"createSubscription": {
"terms": {
"autoRenew": true,
"initialTerm": {
"period": 12,
"termType": "TERMED",
"startDate": "2017-01-01",
"periodType": "Month"
},
"renewalTerms": [
{
"period": 12,
"periodType": "Month"
}
],
"renewalSetting": "RENEW_WITH_SPECIFIC_TERM"
},
"subscriptionNumber": "SM-00004",
"subscribeToRatePlans": [
{
"uniqueToken": "Sugar-free Monthly",
"chargeOverrides": [
{
"startDate": {
"triggerEvent": "SpecificDate"
},
"productRatePlanChargeId": "efbff07e6290dfb80162910024d80dd7"
}
],
"productRatePlanId": "efbff07e6290dfb80162910024c80dd5"
}
]
}
}
]
},
{
"orderActions": [
{
"type": "Suspend",
"suspend": {
"suspendPolicy": "FixedPeriodsFromToday",
"suspendPeriods": 2,
"suspendPeriodsType": "Week"
},
"triggerDates": [
{
"name": "ContractEffective",
"triggerDate": "2018-01-01"
},
{
"name": "ServiceActivation",
"triggerDate": "2018-01-01"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2018-01-01"
}
]
}
],
"subscriptionNumber": "SM-00005"
},
{
"orderActions": [
{
"type": "Resume",
"resume": {
"extendsTerm": true,
"resumePolicy": "SpecificDate",
"resumeSpecificDate": "2018-10-01"
},
"triggerDates": [
{
"name": "ContractEffective",
"triggerDate": "2018-01-01"
},
{
"name": "ServiceActivation",
"triggerDate": "2018-01-01"
},
{
"name": "CustomerAcceptance",
"triggerDate": "2018-01-01"
}
]
}
],
"subscriptionNumber": "SM-00006"
}
],
"orderLineItems": [
{
"billTo": "2c9081a03c6d7b51013c6d7e2dfc09fa",
"soldTo": "4028fc828244a0ac018244dfc9a90bee",
"taxCode": "8018",
"taxMode": "TaxInclusive",
"itemName": "webcam",
"itemType": "Product",
"quantity": 2,
"description": "With Dual Stereo Microphones, HD 1080p, Black",
"productCode": "C9201",
"customFields": {
"someField__c": "some string"
},
"billingTrigger": "BillImmediately",
"listPricePerUnit": 59,
"transactionEndDate": "2021-02-01",
"chargeAmountPerUnit": 50,
"purchaseOrderNumber": "960-000764",
"transactionStartDate": "2021-02-01",
"revenueRecognitionRule": "recognized upon invoice",
"deferredRevenueAccountingCode": "Unearned Revenues",
"recognizedRevenueAccountingCode": "Earned Revenues"
}
],
"processingOptions": {
"runBilling": true,
"billingOptions": {
"targetDate": "2017-08-01",
"creditMemoReasonCode": "Unsatisfactory service"
},
"collectPayment": true,
"applyCreditBalance": true,
"electronicPaymentOptions": {
"paymentMethodId": "2c9890186cb7c157016cd18c6f690999",
"paymentGatewayId": "2c9890186cb7c157016cd18c72370999"
}
},
"existingAccountNumber": "A00000001"
},
"required": [
"orderDate"
],
"properties": {
"status": {
"enum": [
"Draft",
"Pending",
"Completed",
"Scheduled"
],
"type": "string",
"description": "The status of the order. The default value is `Completed`. The following values are supported:\n- `Draft`: The order is in draft status.\n- `Pending`: The order is in pending status.\n- `Completed`: The order is in completed status.\n- `Scheduled`: The order is in scheduled status and it is only valid if the Scheduled Orders feature is enabled.\n- `Executing`: The scheduled order is executed by a scheduler and it is only valid if the Scheduled Orders feature is enabled.\n- `Failed`: The scheduled order has failed.\n"
},
"category": {
"enum": [
"NewSales",
"Return"
],
"type": "string",
"default": "NewSales",
"description": "Category of the order to indicate a product sale or return. Default value is `NewSales`.\n"
},
"orderDate": {
"type": "string",
"format": "date",
"description": "The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null."
},
"reasonCode": {
"type": "string",
"maxLength": 255,
"description": "Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs.\n"
},
"description": {
"type": "string",
"maxLength": 500,
"description": "A description of the order."
},
"orderNumber": {
"type": "string",
"maxLength": 100,
"description": "The order number of the new order. If not provided, system will auto-generate a number for this order. \n**Note:** Make sure the order number does not contain a slash. \n"
},
"customFields": {
"$ref": "#/components/schemas/OrderObjectCustomFields"
},
"subscriptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ramp": {
"$ref": "#/components/schemas/RampRequest"
},
"quote": {
"$ref": "#/components/schemas/QuoteObjectFields"
},
"customFields": {
"$ref": "#/components/schemas/SubscriptionObjectCustomFields"
},
"orderActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOrderOrderAction"
},
"description": "The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request."
},
"subscriptionNumber": {
"type": "string",
"description": "Leave this empty to represent new subscription creation. Specify a subscription number to update an existing subscription.\n"
}
}
},
"description": "Each item includes a set of order actions, which will be applied to the same base subscription."
},
"orderLineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderLineItemCommonPostOrder"
},
"description": "[Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services. \n\nWith the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models.\n\n**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 of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n"
},
"processingOptions": {
"$ref": "#/components/schemas/processingOptionsOrders"
},
"schedulingOptions": {
"type": "object",
"properties": {
"scheduledDate": {
"type": "string",
"format": "date",
"description": "The date for the order scheduled.\n"
},
"scheduledDatePolicy": {
"enum": [
"SpecificDate"
],
"type": "string",
"description": "Date policy of the scheduled order."
}
},
"description": "Information of scheduled order. \n"
},
"externallyManagedBy": {
"enum": [
"Amazon",
"Apple",
"Google",
"Roku"
],
"type": "string",
"description": "An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.\n"
},
"existingAccountNumber": {
"type": "string",
"maxLength": 70,
"description": "The account number that this order will be created under.\nNote that this actually specifies the invoice owner account of the subscriptions included in this order.\n"
}
}
}
PUTOrderTriggerDatesResponseType
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"status": {
"enum": [
"Completed",
"Pending"
],
"type": "string",
"description": "Status of the order."
},
"orderNumber": {
"type": "string",
"description": "The order number of the order updated."
},
"accountNumber": {
"type": "string",
"description": "The account number for the order."
},
"subscriptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"enum": [
"Active",
"Pending Activation",
"Pending Acceptance"
],
"type": "string",
"description": "Status of the subscription. `Pending Activation` and `Pending Acceptance` are only applicable for an order that contains a `CreateSubscription` order action."
},
"subscriptionNumber": {
"type": "string",
"description": "Subscription number of the subscription updated."
}
}
},
"description": "The subscriptions updated."
}
}
}
]
}
PUTPMAccountHolderInfo
{
"type": "object",
"title": "accountHolderInfo",
"properties": {
"city": {
"type": "string",
"description": "The city where the account holder stays.\n"
},
"email": {
"type": "string",
"description": "The email address of the account holder.\n"
},
"phone": {
"type": "string",
"description": "The phone number of the account holder.\n"
},
"state": {
"type": "string",
"description": "The state where the account holder stays.\n"
},
"country": {
"type": "string",
"description": "The country where the account holder stays.\n\nThis field is required for SEPA payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).\n"
},
"zipCode": {
"type": "string",
"description": "The zip code for the address of the account holder.\n"
},
"addressLine1": {
"type": "string",
"description": "The first line of the address for the account holder.\n\nThis field is required for SEPA Direct Debit payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).\n"
},
"addressLine2": {
"type": "string",
"description": "The second line of the address for the account holder. \n"
}
},
"description": "The account holder information. This field is not supported in updating Credit Card Reference Transaction payment methods.\n"
}
PUTPMCreditCardInfo
{
"type": "object",
"properties": {
"securityCode": {
"type": "string",
"description": "Optional. It is the CVV or CVV2 security code specific for the credit card or debit card. To ensure PCI compliance, this value is not stored and cannot be queried. \n\nIf securityCode code is not passed in the request payload, this operation only updates related fields in the payload. It does not validate the payment method through the gateway.\n\nIf securityCode is passed in the request payload, this operation retrieves the credit card information from payload and validates them through the gateway.\n"
},
"expirationYear": {
"type": "integer",
"description": "Four-digit expiration year.\n"
},
"expirationMonth": {
"type": "integer",
"description": "One or two digits expiration month (1-12).\n \n"
}
}
}
PUTPaymentMethodObjectCustomFields
{
"type": "object",
"title": "paymentMethodFieldsCustom",
"description": "Container for custom fields of a payment method object.\n",
"additionalProperties": {
"description": "Custom fields of the payment method. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n\nCustom fields are not supported in updating Credit Card Reference Transaction payment methods.\n"
}
}
PUTPaymentMethodRequest
{
"allOf": [
{
"type": "object",
"properties": {
"ipAddress": {
"type": "string",
"description": "The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. \n\nIf the IP address length is beyond 45 characters, a validation error occurs.\n\nFor validating SEPA payment methods on Stripe v2, this field is required.\n"
},
"accountKey": {
"type": "string",
"description": "The ID of the customer account associated with this payment method, such as `2x92c0f859b0480f0159d3a4a6ee5bb6`.\n\n**Note:** You can use this field to associate an orphan payment method with a customer account. If a payment method is already associated with a customer account, you cannot change the associated payment method through this operation. You cannot remove the previous account ID and leave this field empty, either.\n"
},
"authGateway": {
"type": "string",
"description": "Specifies the ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. \n\nThis field is not supported in updating Credit Card Reference Transaction payment methods.\n"
},
"mandateInfo": {
"type": "object",
"properties": {
"mandateId": {
"type": "string",
"maxLength": 36,
"description": "The mandate ID.\n"
},
"mandateReason": {
"type": "string",
"maxLength": 64,
"description": "The reason of the mandate from the gateway side.\n"
},
"mandateStatus": {
"type": "string",
"maxLength": 64,
"description": "The status of the mandate from the gateway side.\n"
}
},
"description": "The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method.\n"
},
"currencyCode": {
"type": "string",
"description": "The currency used for payment method authorization.\n"
},
"gatewayOptions": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The name of a gateway-specific parameter.\n"
},
"value": {
"type": "string",
"description": "The value of the gateway-specific parameter.\n"
}
},
"description": "The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).\n\nZuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.\n\nThis field is not supported in updating Credit Card Reference Transaction payment methods.\n"
},
"accountHolderInfo": {
"$ref": "#/components/schemas/PUTPMAccountHolderInfo"
},
"processingOptions": {
"type": "object",
"properties": {
"checkDuplicated": {
"type": "boolean",
"description": "Indicates whether to perform a duplication check when you create a payment method of the following types:\n - Credit Card\n - ACH\n - Bank Transfer\n\nThe default value is `false`.\n\nWith this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. \n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods\" target=\"_blank\">Duplication check on payment methods</a>.\n"
}
},
"description": "The container for payment method processing options.\n"
}
}
},
{
"$ref": "#/components/schemas/PUTPMCreditCardInfo"
},
{
"$ref": "#/components/schemas/PUTPaymentMethodObjectCustomFields"
}
],
"example": {
"securityCode": "123",
"expirationYear": 2024,
"expirationMonth": 8,
"accountHolderInfo": {
"phone": "1333333333",
"addressLine1": "address 1"
}
}
}
PUTPaymentMethodResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the updated payment method.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
}
}
}
PUTPaymentRunRequest
{
"type": "object",
"example": {
"targetDate": "2017-10-12",
"autoApplyCreditMemo": "true",
"consolidatedPayment": "true",
"autoApplyUnappliedPayment": "true",
"processPaymentWithClosedPM": "true"
},
"properties": {
"batch": {
"type": "string",
"description": "The alias name given to a batch. The batch name is a string of 50 characters or less.\n\nThis field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned. \n\n**Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite\" target=\"_blank\">Performance Booster Elite</a> package.\n"
},
"runDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the scheduled payment run is to be executed, in `yyyy-mm-dd hh:mm:ss` format. The backend will ignore mintues and seconds in the field value. For example, if you specify `2017-03-01 11:30:37` for this value, this payment run will be run at 2017-03-01 11:00:00.\n"
},
"currency": {
"type": "string",
"description": "A currency defined in the web-based UI administrative settings.\n\nThis field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.\n"
},
"accountId": {
"type": "string",
"format": "uuid",
"description": "The ID of the customer account associated with the payment run.\n\nThis field conflicts with each of the `batch`, `billCycleDay`, `currency`, `paymentGatewayId`, and `billingRunId` fields. If there are such conflicts, an error occurs and an error message is returned.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date used to determine which receivables to be paid in the payment run. The payments are collected for all receivables with the due date no later than the target date.\n"
},
"billCycleDay": {
"type": "string",
"description": "The billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. The value must be equal to or less then 31, and 31 is mean the EOM.\n\nThis field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.\n"
},
"billingRunId": {
"type": "string",
"format": "uuid",
"description": "The ID of a bill run.\n\nThis field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.\n"
},
"collectPayment": {
"type": "boolean",
"description": "Whether to process electronic payments during the execution of payment runs. \n\nIf the Payment user permission \"Process Electronic Payment\" is disabled, this field will be ignored.\n"
},
"paymentGatewayId": {
"type": "string",
"format": "uuid",
"description": "The ID of the gateway instance that processes the payment.\n\nThis field conflicts with the `accountId` field. If they are both specified in the request body, an error occurs and an error message is returned.\n"
},
"applyCreditBalance": {
"type": "boolean",
"description": "**Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.\n\nWhether to apply credit balances in the payment run. This field is only available when you have Invoice Settlement feature disabled.\n"
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organizations that the run is created for. \n\nFor each item in the array, either the `organizationId` or the `organizationName` field is required.\n\nThis field is only required when you have already turned on Multi-Org feature.\n"
},
"autoApplyCreditMemo": {
"type": "boolean",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nWhether to automatically apply a posted credit memo to one or more receivables in the payment run.\n"
},
"consolidatedPayment": {
"type": "boolean",
"description": "**Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information. \n\nWhether to process a single payment for all receivables that are due on an account.\n"
},
"autoApplyUnappliedPayment": {
"type": "boolean",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nWhether to automatically apply unapplied payments to one or more receivables in the payment run.\n"
},
"processPaymentWithClosedPM": {
"type": "boolean",
"description": "**Note:** The **Process Electronic Payment** permission also needs to be allowed for a Manage Payment Runs role to work. See [Payments Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles) for more information. \n\nWhether to process payments even if the default payment method is closed.\n"
}
}
}
PUTPaymentScheduleItemRequest
{
"allOf": [
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "decimal",
"description": "The amount of the payment.\n"
},
"runHour": {
"type": "integer",
"description": "At which hour of the day in the tenant’s timezone this payment will be collected. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.\n"
},
"currency": {
"type": "string",
"description": "The currency of the payment.\n"
},
"paymentId": {
"type": "string",
"description": "ID of the payment to be linked to the payment schedule item.\n\n**Note**: This feild is version controlled. To enable this field, you must set `zuora-version` to equal or smaller than `336.0`.\n"
},
"description": {
"type": "string",
"description": "The description of the payment schedule item.\n"
},
"linkPayments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Container for payments linked to the payment schedule item.\n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\nHere is an example:\n```\n\"paymentOption\": [\n {\n \"type\": \"GatewayOptions\",\n \"detail\": {\n \"SecCode\":\"WEB\"\n }\n }\n]\n```\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
},
"scheduledDate": {
"type": "string",
"format": "date",
"description": "The scheduled date when the payment is processed.\n"
},
"unlinkPayments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Container for payments to be unlinked from the payment schedule item.\n"
},
"paymentMethodId": {
"type": "string",
"description": "ID of the payment method of the payment schedule item.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "ID of the payment gateway of the payment schedule item.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentScheduleItemCustomFields"
}
],
"example": {
"amount": 30,
"runHour": 0,
"currency": "USD",
"paymentId": null,
"property1": null,
"property2": null,
"description": "",
"linkPayments": [
"8a90857b822459cd018324dsb9ec13bf",
"5a50897b823459ch018724dcb9ex63bg"
],
"paymentOption": [
{
"type": "Invoice",
"detail": {
"key": "8a90a2fd819503b50181959525e5205d",
"value": "INV00000001"
}
}
],
"scheduledDate": "2019-08-24",
"unlinkPayments": [
"8a90857b822459cd018324dsb9ec13bf",
"5a50897b823459ch018724dcb9ex63bg"
],
"paymentMethodId": "8a90a2fd8074995801807817ebed52aa",
"paymentGatewayId": "8a90a2fd807499580180781775c452a8"
}
}
PUTPaymentScheduleItemResponse
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the payment schedule item. For example, `412880e749b72b310149b7343ef81346`.\n"
},
"amount": {
"type": "number",
"format": "decimal",
"description": "The amount of the payment schedule item.\n"
},
"number": {
"type": "string",
"description": "Number of the payment schedule item.\n"
},
"status": {
"enum": [
"Pending",
"Processed",
"Error",
"Canceled"
],
"type": "string",
"description": "ID of the payment method of the payment schedule item.\n\n- `Pending`: Waiting for processing.\n- `Processed`: The payment has been collected.\n- `Error`: Failed to collect the payment.\n- `Canceled`: After a pending payment schedule item is canceled by the user, the item is marked as `Canceled`.\n"
},
"balance": {
"type": "number",
"format": "decimal",
"description": "The remaining balance of payment schedule item. \n"
},
"runHour": {
"type": "integer",
"description": "At which hour in the day in the tenant’s timezone this payment will be collected.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully. \n"
},
"currency": {
"type": "string",
"description": "The currency of the payment.\n"
},
"accountId": {
"type": "string",
"description": "ID of the customer account that owns the payment schedule item, for example `402880e741112b310149b7343ef81234`.\n"
},
"paymentId": {
"type": "string",
"description": "ID of the payment that is created by the payment schedule item, or linked to the payment schedule item. This field is only available if the request doesn’t specify `zuora-version`, or `zuora-version` is set to a value equal to or smaller than `336.0`. \n"
},
"standalone": {
"type": "boolean",
"description": "Indicates if the payment created by the payment schedule item is a standalone payment.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the user who created the payment schedule item.\n"
},
"createdDate": {
"type": "string",
"format": "date",
"description": "The date and time when the payment schedule item was created.\n"
},
"description": {
"type": "string",
"description": "The description of the payment schedule item.\n"
},
"psiPayments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LinkedPaymentID"
},
"description": "Container for payments linked to the payment schedule item.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the user who updated the payment schedule item.\n"
},
"updatedDate": {
"type": "string",
"format": "date",
"description": "The date and time when the payment schedule item was last updated.\n"
},
"errorMessage": {
"type": "string",
"description": "The error message indicating if the error is related to the configuration or the payment collection.\n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
},
"scheduledDate": {
"type": "string",
"format": "date",
"description": "The scheduled date when the payment is processed.\n"
},
"billingDocument": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.\n"
},
"type": {
"type": "string",
"description": "Indicates whether the associated billing document is a debit memo or a invoice.\n"
},
"number": {
"type": "string",
"description": "The number of the billing docuemnt, for example, `INV00002345`.\n"
}
}
},
"paymentMethodId": {
"type": "string",
"description": "ID of the payment method of the payment schedule item.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "ID of the payment gateway of the payment schedule item.\n"
},
"paymentScheduleId": {
"type": "string",
"description": "ID of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`,\n"
},
"cancellationReason": {
"type": "string",
"description": "The reason for the cancellation of payment schedule item. \n"
},
"paymentScheduleNumber": {
"type": "string",
"description": "Number of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`,\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentScheduleItemCustomFields"
}
]
}
PUTPaymentScheduleRequest
{
"allOf": [
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Indicates the updated amount of the pending payment schedule items.\n"
},
"period": {
"enum": [
"Monthly",
"Weekly",
"BiWeekly"
],
"type": "string",
"description": "Indicates the updated period of the pending payment schedule items.\n"
},
"runHour": {
"type": "integer",
"format": "date",
"description": "Specifies at which hour of the day in the tenant’s time zone this payment will be collected. Available values: `[0,1,2,~,22,23]`.\n \nIf the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.\n"
},
"currency": {
"type": "string",
"description": "Indicates the updated currency of the pending payment schedule items. \n"
},
"occurrences": {
"type": "integer",
"description": "Indicates the updated number of payment schedule items that are created by the payment schedule.\n\n**Note:**\n - If \"updated `occurrences` > existing `occurrences`\", the following number of pending payment schedule item will be added to the payment schedule: “updated `occurrences` - existing `occurrences`”.\n - If \"existing `occurrences` > updated `occurrences` >= the number of `processed`/`errored`/`canceled` payment schedule items\", the following number of pending items will be removed by descending order of the schedule dates: \"existing `occurrences` - updated `occurrences`\".\n - If \"updated `occurrences` < the number of `processed`/`erroed`/`canceled` payment schedule items\", a validation error will be returned.\n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\nHere is an example:\n```\n\"paymentOption\": [\n {\n \"type\": \"GatewayOptions\",\n \"detail\": {\n \"SecCode\":\"WEB\"\n }\n }\n]\n```\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n\n **Note:** To enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/).\n"
},
"paymentMethodId": {
"type": "string",
"description": "Indicates the updated payment method ID of the pending payment schedule items. \n"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "Indicates the updated collection date for the next pending payment schedule item.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "Indicates the updated payment gateway ID of the pending payment schedule items.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentScheduleCustomFields"
}
]
}
PUTPreviewPaymentScheduleRequest
{
"allOf": [
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Indicates the updated amount of the pending payment schedule items.\n"
},
"period": {
"enum": [
"Monthly",
"Weekly",
"BiWeekly"
],
"type": "string",
"description": "Indicates the updated period of the pending payment schedule items.\n"
},
"runHour": {
"type": "integer",
"format": "date",
"description": "Specifies at which hour of the day in the tenant’s time zone this payment will be collected. Available values: `[0,1,2,~,22,23]`.\n \nIf the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.\n"
},
"currency": {
"type": "string",
"description": "Indicates the updated currency of the pending payment schedule items. \n"
},
"occurrences": {
"type": "integer",
"description": "Indicates the updated number of payment schedule items that are created by the payment schedule.\n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\nHere is an example:\n```\n\"paymentOption\": [\n {\n \"type\": \"GatewayOptions\",\n \"detail\": {\n \"SecCode\":\"WEB\"\n }\n }\n]\n```\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
},
"paymentMethodId": {
"type": "string",
"description": "Indicates the updated payment method ID of the pending payment schedule items. \n"
},
"periodStartDate": {
"type": "string",
"format": "date",
"description": "Indicates the updated collection date for the next pending payment schedule item.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "Indicates the updated payment gateway ID of the pending payment schedule items.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentScheduleCustomFields"
}
]
}
PUTProductChargeDefinitionBulkRequest
{
"type": "object",
"example": {
"productChargeDefinitions": [
{
"uom": "Each",
"term": 24,
"prices": [
{
"price": 10,
"currency": "USD"
}
],
"taxCode": "a valid tax code",
"taxMode": "TaxExclusive",
"taxable": false,
"termType": "TERMED",
"chargeModel": "FlatFee",
"billingPeriod": "Specific_Months",
"listPriceBase": "Per_Billing_Period",
"termPeriodType": "Month",
"defaultQuantity": 10,
"specificBillingPeriod": 10,
"specificListPriceBase": 101,
"productChargeDefinitionKey": "CD-00000037"
}
]
},
"properties": {
"productChargeDefinitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTBulkProductChargeDefinitionRequest"
},
"description": "The list of updated product charge definitions.\n"
}
}
}
PUTProductChargeDefinitionRequest
{
"type": "object",
"example": {
"uom": "Each",
"term": 12,
"prices": [
{
"price": 15,
"currency": "USD"
}
],
"termType": "TERMED",
"billingPeriod": "Specific_Months",
"listPriceBase": "Per_Billing_Period",
"termPeriodType": "Month",
"defaultQuantity": 10,
"effectiveEndDate": "2024-07-01 00:00:00",
"effectiveStartDate": "2024-01-01 00:00:00",
"specificBillingPeriod": 5,
"specificListPriceBase": 10
},
"properties": {
"uom": {
"type": "string",
"nullable": true,
"description": "Describes the unit of measure (UOM) configured in **Settings > Billing**.\n\n**Values**: `Each`, `License`, `Seat`, or `null`\n"
},
"term": {
"type": "number",
"nullable": true,
"description": "The number of periods of a termed subscription that is eligible for this charge definition. This field is applicable when the `termType` field is set to `TERMED`, \nand is to be used together with the `termPeriodType` field.\n"
},
"prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTProductChargeDefinitionPricing"
},
"description": "Container for the new prices to override the existing prices of the product charge definition.\n"
},
"taxCode": {
"type": "string",
"maxLength": 64,
"description": "Specifies the tax code for taxation rules. This field is equired when the `Taxable` field is set to `True`.\n\n**Note**: This value affects the tax calculation of the charge.\n"
},
"taxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive",
null
],
"type": "string",
"nullable": true,
"description": "Determines how to define taxation for the charge. This field is equired when the `Taxable` field is set to `True`.\n\n**Note**: This value affects the tax calculation of the charge.\n"
},
"taxable": {
"type": "boolean",
"description": "Determines whether the charge definition is taxable. When this field is set to `True`, the `TaxMode` and `TaxCode` fields are required.\n\n**Character limit**: 5\n\n**Values**: `True`, `False`\n\n**Note**: This value affects the tax calculation of the charge.\n"
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN",
null
],
"type": "string",
"nullable": true,
"description": "The type of the subscription that is eligible for this charge definition.\n"
},
"chargeModel": {
"enum": [
"DiscountFixedAmount",
"DiscountPercentage",
"FlatFee",
"PerUnit",
"Tiered",
"Volume",
"Delivery"
],
"type": "string",
"description": "Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n"
},
"billingPeriod": {
"type": "string",
"description": "The override value of the billingPeriod for the product charge definition.\n"
},
"billingTiming": {
"enum": [
"IN_ADVANCE",
"IN_ARREARS"
],
"type": "string",
"description": "The override value of the billingTiming for the product charge definition.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year"
],
"type": "string",
"description": "The list price base. \n\nThis field is applicable only for recurring charges.\n\n**Note**: The `Per_Year` enum value is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n"
},
"termPeriodType": {
"enum": [
"Month",
"Year",
"Day",
"Week",
null
],
"type": "string",
"nullable": true,
"description": "Specifies the period type for the subscription term that is eligible for this charge definition.\n"
},
"defaultQuantity": {
"type": "number",
"nullable": true,
"description": "The default quantity. \n\nThis field is applicable only for one-time and recurring charges.\n"
},
"effectiveEndDate": {
"type": "string",
"format": "date-time",
"description": "The effective end date of the product charge definition.\n"
},
"effectiveStartDate": {
"type": "string",
"format": "date-time",
"description": "The effective start date of the product charge definition.\n"
},
"specificBillingPeriod": {
"type": "number",
"nullable": true,
"description": "The override value of the specificBillingPeriod for the product charge definition.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"nullable": true,
"description": "The number of months for the list price base of the charge definition. \nThe field is `null` if the `listPriceBase` field is not set to `Per_Specific_Months`.\n"
}
}
}
PUTPublicEmailTemplateRequest
{
"type": "object",
"example": {
"name": "Account Edit Email",
"active": true,
"isHtml": true,
"fromName": "Example Co. Ltd.",
"emailBody": "Dear user,<p>the account <Account.Name> has been edited. <p>Example Co. Ltd.",
"ccEmailType": "SpecificEmails",
"description": "Email when an account is edited",
"toEmailType": "BillToContact",
"emailHeaders": {
"My-Header-1": "Header value 1",
"My-Header-2": "Header value 2"
},
"emailSubject": "Account <Account.Number> has been edited",
"encodingType": "UTF8",
"fromEmailType": "TenantEmail",
"ccEmailAddress": "user@example.com",
"toEmailAddress": null,
"bccEmailAddress": "user@example.com",
"fromEmailAddress": null,
"replyToEmailType": "TenantEmail",
"replyToEmailAddress": null
},
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the email template."
},
"active": {
"type": "boolean",
"description": "The status of the email template."
},
"isHtml": {
"type": "boolean",
"description": "Indicates whether the style of email body is HTML."
},
"fromName": {
"type": "string",
"description": "The name of email sender."
},
"emailBody": {
"type": "string",
"description": "The email body. You can add merge fields in the email body using angle brackets or double curly brackets. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates\" target=\"_blank\">Merge field syntax for email templates</a>. \n\nUser can also embed html tags if `isHtml` is `true`.\n"
},
"ccEmailType": {
"enum": [
"BillToContact",
"SoldToContact",
"SpecificEmails",
"TenantAdmin",
"BillToAndSoldToContacts",
"RunOwner",
"AllContacts",
"InvoiceOwnerBillToContact",
"InvoiceOwnerSoldToContact",
"InvoiceOwnerBillToAndSoldToContacts",
"InvoiceOwnerAllContacts"
],
"type": "string",
"default": "SpecificEmails",
"description": "Email CC type.\n* When the base object for the event is associated with `Account`, `ccEmailType` can be any values in the enum list. \n* When the base object for the event is not associated with `Account`, `ccEmailType` must be `TenantAdmin`, `RunOwner`, or `SpecificEmail`. "
},
"description": {
"type": "string",
"maxLength": 255,
"description": "The description of the email template."
},
"toEmailType": {
"enum": [
"BillToContact",
"SoldToContact",
"SpecificEmails",
"TenantAdmin",
"BillToAndSoldToContacts",
"RunOwner",
"AllContacts",
"InvoiceOwnerBillToContact",
"InvoiceOwnerSoldToContact",
"InvoiceOwnerBillToAndSoldToContacts",
"InvoiceOwnerAllContacts"
],
"type": "string",
"description": "Email receive type.\n* When the base object for the event is associated with `Account`, `toEmailType` can be any values in the enum list. \n* When the base object for the event is not associated with `Account`, `toEmailType` must be `TenantAdmin`, `RunOwner`, or `SpecificEmail`. "
},
"emailHeaders": {
"type": "object",
"title": "emailHeader",
"description": "Container for custom email headers. Each custom email header consists of a header name and a header value.\n",
"additionalProperties": {
"type": "string",
"description": "The custom email header consists of a name-value pair:\n\n* Field name: the name of the custom email header.\n\n* Field value: the value of the custom email header. You can add merge fields in the field value. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates\" target=\"_blank\">Merge field syntax for email templates</a>.\n"
}
},
"emailSubject": {
"type": "string",
"description": "The email subject. You can add merge fields in the email subject using angle brackets or double curly brackets. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates\" target=\"_blank\">Merge field syntax for email templates</a>.\n"
},
"encodingType": {
"enum": [
"UTF8",
"Shift_JIS",
"ISO_2022_JP",
"EUC_JP",
"X_SJIS_0213"
],
"type": "string",
"description": "The endcode type of the email body."
},
"fromEmailType": {
"enum": [
"TenantEmail",
"RunOwner",
"SpecificEmail"
],
"type": "string",
"description": "The type of fromEmail."
},
"ccEmailAddress": {
"type": "string",
"description": "Email cc address."
},
"toEmailAddress": {
"type": "string",
"description": "If toEmailType is SpecificEmail, this field is required."
},
"bccEmailAddress": {
"type": "string",
"format": "email",
"description": "Email bcc address."
},
"fromEmailAddress": {
"type": "string",
"description": "If fromEmailType is SpecificEmail, this field is required"
},
"replyToEmailType": {
"enum": [
"TenantEmail",
"RunOwner",
"SpecificEmail"
],
"type": "string",
"description": "The type of the reply email."
},
"replyToEmailAddress": {
"type": "string",
"description": "If replyToEmailType is SpecificEmail, this field is required."
}
}
}
PUTPublicNotificationDefinitionCalloutBasicAuthentication
{
"allOf": [
{
"$ref": "#/components/schemas/PUTPublicNotificationDefinitionCalloutCommon"
},
{
"type": "object",
"properties": {
"calloutAuth": {
"$ref": "#/components/schemas/CalloutAuth"
},
"requiredAuth": {
"type": "boolean",
"description": "Indicates whether Basic authentication is enabled for the callout.\n"
}
},
"description": "The Basic Authentication information for callout notifications.\n"
}
],
"title": "Callout - Base authentication"
}
PUTPublicNotificationDefinitionCalloutCommon
{
"type": "object",
"title": "Callout - without authentication",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the created callout."
},
"active": {
"type": "boolean",
"default": true,
"description": "The status of the callout. The default value is `true`."
},
"httpMethod": {
"enum": [
"GET",
"PUT",
"POST",
"DELETE"
],
"type": "string",
"example": "POST",
"description": "The HTTP method of the callout."
},
"description": {
"type": "string",
"maxLength": 255,
"description": "Description for the callout."
},
"calloutRetry": {
"type": "boolean",
"default": true,
"description": "Specified whether to retry the callout when the callout fails. The default value is `true`."
},
"calloutParams": {
"$ref": "#/components/schemas/CalloutMergeFields"
},
"calloutBaseurl": {
"type": "string",
"format": "url",
"example": "https://***",
"minLength": 10,
"description": "The callout URL. It must start with 'https://'"
}
},
"description": "Common information for callout notifications.\n"
}
PUTPublicNotificationDefinitionCalloutOauth2Authentication
{
"allOf": [
{
"$ref": "#/components/schemas/PUTPublicNotificationDefinitionCalloutCommon"
},
{
"type": "object",
"properties": {
"requiredOauth2": {
"type": "boolean",
"description": "Indicates whether OAuth 2.0 authentication is enabled for the callout.\n"
},
"oauth2ProviderId": {
"description": "The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout.\n\nFor more information about how to get the ID of an OAuth 2.0 provider, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/Add_an_OAuth_2.0_Provider#Retrieve_the_ID_of_an_OAuth_2.0_provider\" target=\"_blank\">Retrieve the ID of an OAuth 2.0 provider</a>.\n"
}
},
"description": "The OAuth 2.0 Authentication information for callout notifications.\n"
}
],
"title": "Callout - OAuth 2.0 authentication"
}
PUTPublicNotificationDefinitionRequest
{
"type": "object",
"example": {
"name": "Account Edit Notification",
"active": true,
"callout": {
"name": "Callout for Account Edited",
"active": true,
"httpMethod": "POST",
"calloutAuth": {
"domain": "example_domain",
"password": "example_password",
"username": "example_user",
"preemptive": true
},
"description": "Callout when an account is edited",
"calloutRetry": true,
"requiredAuth": true,
"calloutParams": {
"AccountName": "<Account.Name>",
"AccountNumber": "<Account.Number>"
},
"calloutBaseurl": "https://www.example.com/callout/AccountEdit"
},
"filterRule": {
"condition": "Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS",
"parameters": {
"_ACCOUNT_STATUS": {
"options": [
"Draft",
"Active",
"Canceled"
],
"valueType": "STRING",
"description": "The status of the VIP Account",
"displayName": "VIP Account Status"
},
"_VIP_BALANCE_AMOUNT": {
"options": null,
"valueType": "BIG_DECIMAL",
"description": "The minimum account balance",
"displayName": "VIP Account Balance"
}
},
"description": "Filter rule to test if an account is a VIP account"
},
"description": "Notification sent out when an account is edited",
"emailActive": true,
"calloutActive": true,
"emailTemplateId": "6e569e1e05f040eda51a927b140c0ac6",
"filterRuleParams": {
"_ACCOUNT_STATUS": "Active",
"_VIP_BALANCE_AMOUNT": "100000"
},
"communicationProfileId": "6e569e1e05f040eda51a927b140c0ac5"
},
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the notification definition, which is unique in the profile."
},
"active": {
"type": "boolean",
"default": true,
"description": "The status of the notification definition. The default value is `true`."
},
"callout": {
"oneOf": [
{
"$ref": "#/components/schemas/PUTPublicNotificationDefinitionCalloutCommon"
},
{
"$ref": "#/components/schemas/PUTPublicNotificationDefinitionCalloutBasicAuthentication"
},
{
"$ref": "#/components/schemas/PUTPublicNotificationDefinitionCalloutOauth2Authentication"
}
]
},
"filterRule": {
"type": "object",
"required": [
"eventTypeName",
"condition",
"parameters"
],
"properties": {
"condition": {
"type": "string",
"example": "Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS",
"description": "The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/).\nThe rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to trigger an event when an invoice is posted with the amount over 1000, you would define the following condition on the `Invoice` object:\n\n```changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000```\n\nThere are conventions and keywords you need to be aware of. For example:\n\n* `changeType` is a keyword to specify what kind of change happened to the object. Allowed values are `INSERT`, `UPDATE` or `DELETE`.\n\n* `Invoice.Status` refers to field `Status` of the Zuora object `Invoice`.\n\n* A variable with the `_old` suffix means it’s a previous value of the corresponding object field. The \"_old\" fields are only available on the base objects.\n"
},
"parameters": {
"$ref": "#/components/schemas/FilterRuleParameterDefinitions"
},
"description": {
"type": "string",
"maxLength": 255,
"description": "The description of the filter rule."
}
},
"description": ""
},
"description": {
"type": "string",
"maxLength": 255,
"description": "The description of the notification definition."
},
"emailActive": {
"type": "boolean",
"default": false,
"description": "The status of the email action. The default value is `false`."
},
"calloutActive": {
"type": "boolean",
"default": false,
"description": "The status of the callout action. The default value is `false`."
},
"emailTemplateId": {
"type": "string",
"format": "uuid",
"description": "The ID of the email template. If emailActive is updated from\nfalse to true, an email template is required, and the EventType of\nthe email template MUST be the same as the EventType of the notification definition.\n"
},
"filterRuleParams": {
"$ref": "#/components/schemas/FilterRuleParameterValues"
},
"associatedAccount": {
"type": "string",
"description": "The account on which the histories of this notification will be displayed. The associated account does not enforce where the merge fields come from.\nAvailable values are as follows:\n* `Account.Id`: ID of the primary customer account related to the notification. It is also the default value.\n* `ParentAccount.Id`: this option is available only if you have <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\" target=\"_blank\">Customer Hierarchy</a> enabled for your tenant.\n* `SubscriptionOwnerAccount.Id`: this option is available if the base object of the notification is Order Action.\n\n**Note:** before specifying this field, we recommend that you use [Data Source](https://knowledgecenter.zuora.com/Billing/Reporting/D_Data_Sources_and_Exports/C_Data_Source_Reference) to check the available types of accounts for the current notification. \n"
},
"communicationProfileId": {
"type": "string",
"format": "uuid",
"description": "The profile that notification definition belongs to. If you want to\nupdate the notification to a system notification, you should pass\n'SystemNotification'. '\n"
}
}
}
PUTPublishOpenPaymentMethodTypeResponse
{
"properties": {
"label": {
"type": "string",
"description": "The label that is used to refer to this type in the Zuora UI.\n"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OpenPaymentMethodTypeResponseFields"
},
"description": "An array containing field metadata of the custom payment method type.\n"
},
"status": {
"type": "string",
"description": "The status of the custom payment method type.\n"
},
"version": {
"type": "string",
"description": "The time when the custom payment method type was first published.\n"
},
"entityId": {
"type": "string",
"description": "If an entity UUID is provided, this custom payment method type is specific to this entity only. If no entity UUID is provided, the custom payment method type is available to the global entity and all the sub entities in the tenant.\n"
},
"revision": {
"type": "integer",
"description": "The revision number of the custom payment method type, which starts from 1 and increases by 1 when you update a published revision for the first time.\n"
},
"tenantId": {
"type": "string",
"description": "Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities.\n"
},
"internalName": {
"type": "string",
"description": "A string to identify the custom payment method type in the API name of the payment method type.\n\nThis field is used along with the `tenantId` field by the system to construct and generate the API name of the custom payment method type in the following way:\n\n`<internalName>__c_<tenantId>`\n\nFor example, if `internalName` is `AmazonPay`, and `tenantId` is `12368`, the API name of the custom payment method type will be `AmazonPay__c_12368`.\n"
},
"subTypeField": {
"type": "string",
"description": "The identification reference indicating the subtype of the custom payment method.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.\n"
},
"userReferenceIdField": {
"type": "string",
"description": "The identification reference of the user or customer account.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.\n"
},
"methodReferenceIdField": {
"type": "string",
"description": "The identification reference of the custom payment method.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query.\n"
}
}
}
PUTRefundType
{
"allOf": [
{
"type": "object",
"properties": {
"comment": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "Comments about the refund.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n"
},
"referenceId": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The transaction ID returned by the payment gateway. Use this field to reconcile refunds between your gateway and Zuora Payments.\n\nYou can only update the reference ID for external refunds.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the unapplied payment.\n"
}
},
"description": "Container for the finance information related to the refund.\n"
}
}
},
{
"$ref": "#/components/schemas/RefundObjectNSFields"
},
{
"$ref": "#/components/schemas/RefundObjectCustomFields"
}
],
"example": {
"comment": "update comment",
"financeInformation": {
"transferredToAccounting": "No"
}
}
}
PUTRenewSubscriptionResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"invoiceId": {
"type": "string",
"description": "Invoice ID, if one is generated.\n"
},
"paymentId": {
"type": "string",
"description": "Payment ID, if payment is collected.\n"
},
"paidAmount": {
"type": "number",
"description": "Payment amount, if payment is collected.\n"
},
"termEndDate": {
"type": "string",
"format": "date",
"description": "Date the new subscription term ends, as yyyy-mm-dd.\n"
},
"creditMemoId": {
"type": "string",
"description": "The credit memo ID, if a credit memo is generated during the subscription process.\n\n**Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, and 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"termStartDate": {
"type": "string",
"format": "date",
"description": "Date the new subscription term begins, as yyyy-mm-dd.\n"
},
"totalDeltaMrr": {
"type": "number",
"description": "Change in the subscription monthly recurring revenue as a result of the update. For a renewal, this is the MRR of the subscription in the new term.\n"
},
"totalDeltaTcv": {
"type": "number",
"description": "Change in the total contracted value of the subscription as a result of the update. For a renewal, this is the TCV of the subscription in the new term.\n"
}
}
}
PUTRenewSubscriptionType
{
"type": "object",
"example": {
"collect": false,
"runBilling": true,
"creditMemoReasonCode": "Unsatisfactory service"
},
"properties": {
"collect": {
"type": "boolean",
"default": false,
"description": "Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.\n\nIf the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.\n\nPrerequisite: The `invoice` or `runBilling` field must be `true`. \n\n**Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"invoice": {
"type": "boolean",
"description": "**Note:** This field has been replaced by the `runBilling` field. The\n`invoice` field is only available for backward compatibility.\n\n\nCreates an invoice for a subscription. The invoice generated in this\noperation is only for this subscription, not for the entire customer\naccount.\n\n\nIf the value is `true`, an invoice is created. If the value is\n`false`, no action is taken. The default value is `false`. \n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `196.0` and `207.0`. To use this field in the method, you\nmust set the zuora-version parameter to the minor version number in\nthe request header.\n"
},
"orderDate": {
"type": "string",
"format": "date",
"description": "The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date.\nThis field must be in the `yyyy-mm-dd` format.\nThis field is required for Orders customers only, not applicable to Orders Harmonization customers.\n"
},
"runBilling": {
"enum": [
true,
false
],
"type": "boolean",
"default": false,
"description": "Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos). \n\n\nThe billing documents generated\nin this operation is only for this subscription, not for the entire\ncustomer account.\n\n\nPossible values:\n\n- `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.\n\n\n- `false`: No invoice is created.\n\n\n**Note:** This field is in Zuora REST API version control. Supported\nminor versions are `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). To use this field in the method,\nyou must set the `zuora-version` parameter to the minor version number\nin the request header.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice or a credit memo is generated, as\nyyyy-mm-dd. Default is current date.\n\n\n**Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.\n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `211.0` and later. To use this field in the method, you\nmust set the `zuora-version` parameter to the minor version number in\nthe request header.\n"
},
"applyCredit": {
"type": "boolean",
"description": "If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.\n\n**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"documentDate": {
"type": "string",
"format": "date",
"description": "The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.\n\n- If this field is specified, the specified date is used as the billing document date. \n- If this field is not specified, the date specified in the `targetDate` is used as the billing document date.\n"
},
"invoiceCollect": {
"type": "boolean",
"default": true,
"description": "**Note:** This field has been replaced by the `invoice` field\nand the `collect` field. `invoiceCollect` is available only for backward compatibility.\n\n\nIf this field is set to `true`, an invoice is generated and payment collected automatically during the subscription process. If `false`, no invoicing or payment takes place. The invoice generated in this operation is only for this subscription, not for the entire customer account.\n\n\n**Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`.\n"
},
"applicationOrder": {
"type": "array",
"items": {
"type": "string"
},
"description": "The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.\n\n**Note:**\n - This field is valid only if the `applyCredit` field is set to `true`.\n - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.\n - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.\n"
},
"invoiceTargetDate": {
"type": "string",
"format": "date",
"description": "**Note:** This field has been replaced by the `targetDate` field. The\n`invoiceTargetDate` field is only available for backward\ncompatibility.\n\n\nDate through which to calculate charges if an invoice is generated, as\nyyyy-mm-dd. Default is current date.\n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `207.0` and earlier [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"applyCreditBalance": {
"type": "boolean",
"description": "Whether to automatically apply a credit balance to an invoice.\n\nIf the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.\n\n\nTo view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.\n\nPrerequisite: `invoice` must be `true`. \n\n**Note:** \n - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.\n - This field is deprecated if you have the Invoice Settlement feature enabled.\n"
},
"creditMemoReasonCode": {
"type": "string",
"description": "A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code."
}
}
}
PUTRevproAccCodeResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": ""
}
}
}
PUTScAddType
{
"allOf": [
{
"type": "object",
"required": [
"productRatePlanChargeId"
],
"properties": {
"price": {
"type": "number",
"description": "Price for units in the subscription rate plan.\n\nSupports all charge types for the Flat Fee and Per Unit charge models\n"
},
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTTierType"
},
"description": "Container for Volume, Tiered or Tiered with Overage charge models. Supports the following charge types:\n\n* One-time\n* Recurring\n* Usage-based\n"
},
"number": {
"type": "string",
"description": "Unique number that identifies the charge. System-generated if not provided.\n"
},
"quantity": {
"type": "number",
"description": "Number of units. Must be >=`0`.\n\nAvailable for the following charge types for the Per Unit, Volume Pricing, and Tiered Pricing charge models:\n\n* One-time\n* Recurring\n"
},
"isUnbilled": {
"type": "boolean",
"description": "This field is used to dictate how to perform the accounting during revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"description": {
"type": "string",
"description": "Description of the charge.\n"
},
"ratingGroup": {
"type": "string",
"description": "Specifies a rating group based on which usage records are rated.\n\nPossible values:\n\n- `ByBillingPeriod` (default): The rating is based on all the usages in a billing period.\n- `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. \n- `ByUsageRecord`: The rating is based on each usage record.\n- `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`).\n- `ByGroupId`: The rating is based on all the usages in a custom group.\n\n**Note:** \n- The `ByBillingPeriod` value can be applied for all charge models. \n- The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. \n- The `ByGroupId` value is only available if you have the Active Rating feature enabled.\n- Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`.\n"
},
"triggerDate": {
"type": "string",
"format": "date",
"description": "Specifies when to start billing the customer for the charge. Required if the `triggerEvent` field is set to `USD`.\n"
},
"upToPeriods": {
"type": "integer",
"format": "int64",
"description": "The period type used to define when the charge ends. \n\nValues:\n\n* `Billing_Periods`\n* `Days`\n* `Weeks`\n* `Months`\n* `Years`\n\nYou must use this field together with the `upToPeriods` field to specify the time period.\n\nThis field is applicable only when the `endDateCondition` field is set to `Fixed_Period`. \n"
},
"billCycleDay": {
"type": "string",
"description": "Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed.\n\nValues: `1`-`31`\n\nAvailable for the following charge types:\n\n* Recurring\n* Usage-based\n"
},
"overagePrice": {
"type": "number",
"description": "Price for units over the allowed amount. \n\nAvailable for the following charge type for the Overage and Tiered with Overage charge models:\n\n* Usage-based\n"
},
"triggerEvent": {
"type": "string",
"description": "Specifies when to start billing the customer for the charge.\n\nValues:\n\n* `UCE`\n* `USA`\n* `UCA`\n* `USD`\n"
},
"billCycleType": {
"type": "string",
"description": "Specifies how to determine the billing day for the charge. When this field is set to `SpecificDayofMonth`, set the `BillCycleDay` field. When this field is set to `SpecificDayofWeek`, set the `weeklyBillCycleDay` field.\n\nValues:\n\n* `DefaultFromCustomer`\n* `SpecificDayofMonth`\n* `SubscriptionStartDay`\n* `ChargeTriggerDay`\n* `SpecificDayofWeek`\n\nAvailable for the following charge types:\n\n* Recurring\n* Usage-based\n"
},
"billingPeriod": {
"type": "string",
"description": "Billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD). When you renew a subscription, the current subscription term is extended by creating a new term. If any charge in your subscription has the billing period set as `SubscriptionTerm`， a new charge segment is generated for the new term.\n\nValues:\n\n* `Month`\n* `Quarter`\n* `Semi_Annual`\n* `Annual`\n* `Eighteen_Months`\n* `Two_Years`\n* `Three_Years`\n* `Five_Years`\n* `Specific_Months`\n* `Subscription_Term`\n* `Week`\n* `Specific_Weeks`\n\nAvailable for the following charge types:\n\n* Recurring\n* Usage-based\n"
},
"billingTiming": {
"type": "string",
"description": "Billing timing for the charge for recurring charge types. Not avaliable for one time, usage and discount charges.\n\nValues:\n\n* `IN_ADVANCE` (default)\n* `IN_ARREARS`\n"
},
"discountLevel": {
"type": "string",
"description": "Specifies if the discount applies to the product rate plan only , the entire subscription, or to any activity in the account.\n\nValues:\n\n* `rateplan`\n* `subscription`\n* `account`\n\nAvailable for the following charge type for the Discount-Fixed Amount and Discount-Percentage charge models:\n\n* Recurring\n"
},
"includedUnits": {
"type": "number",
"description": "Specifies the number of units in the base set of units for this charge. Must be >=`0`.\n\nAvailable for the following charge type for the Overage charge model:\n\n* Usage-based\n"
},
"listPriceBase": {
"type": "string",
"description": "The list price base for the product rate plan charge.\n\nValues:\n\n* `Per_Billing_Period`\n* `Per_Month`\n* `Per_Week`\n* `Per_Year`\n* `Per_Specific_Months`\n\nAvailable for the following charge type for the Flat Fee, Per Unit, Volume Pricing, and Tiered Pricing charge models:\n\n* Recurring\n"
},
"discountAmount": {
"type": "number",
"description": "Specifies the amount of fixed-amount discount.\n\nAvailable for the following charge type for the Discount-Fixed Amount charge model:\n\n* Recurring\n"
},
"applyDiscountTo": {
"type": "string",
"description": "Specifies the type of charges that you want a specific discount to apply to.\n\nValues:\n\n* `ONETIME`\n* `RECURRING`\n* `USAGE`\n* `ONETIMERECURRING`\n* `ONETIMEUSAGE`\n* `RECURRINGUSAGE`\n* `ONETIMERECURRINGUSAGE`\n\nAvailable for the following charge type for the Discount-Fixed Amount and Discount-Percentage charge models:\n\n* Recurring\n"
},
"numberOfPeriods": {
"type": "integer",
"format": "int64",
"description": "Specifies the number of periods to use when calculating charges in an overage smoothing charge model.\n\nAvailable for the following charge type for the Overage and Tiered with Overage charge models:\n\n* Usage-based\n"
},
"specificEndDate": {
"type": "string",
"format": "date",
"description": "Defines when the charge ends after the charge trigger date.\n\nThis field is only applicable when the `endDateCondition` field is set to `Specific_End_Date`.\n\nIf the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date.\n"
},
"upToPeriodsType": {
"type": "string",
"description": "The period type used to define when the charge ends. \n\nValues:\n\n* `Billing_Periods`\n* `Days`\n* `Weeks`\n* `Months`\n* `Years`\n\nYou must use this field together with the `upToPeriods` field to specify the time period.\n\nThis field is applicable only when the `endDateCondition` field is set to `Fixed_Period`. \n"
},
"amendedByOrderOn": {
"type": "string",
"description": "The date when the rate plan charge is amended through an order or amendment. This field is not updatable.\n\nThis field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n"
},
"endDateCondition": {
"type": "string",
"description": "Defines when the charge ends after the charge trigger date. If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date.\n\nValues:\n\n* `Subscription_End`\n* `Fixed_Period`\n* `Specific_End_Date`\n* `One_Time`\n"
},
"originalOrderDate": {
"type": "string",
"format": "date",
"description": "The date when the rate plan charge is created through an order or amendment. This field is not updatable.\n\nThis field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.\n"
},
"priceChangeOption": {
"type": "string",
"description": "Applies an automatic price change when a termed subscription is renewed. The Zuora Billing Admin setting Enable Automatic Price Change When Subscriptions are Renewed? must be set to Yes to use this field. See Define Default Subscription Settings for more information on setting this option.\n\nValues:\n\n* `NoChange` (default)\n* `SpecificPercentageValue`\n* `UseLatestProductCatalogPricing`\n\nAvailable for the following charge types:\n\n* Recurring\n* Usage-based\n* Not available for the Fixed-Amount Discount charge model.\n"
},
"discountPercentage": {
"type": "number",
"description": "Specifies the percentage of a percentage discount. \n\nAvailable for the following charge type for the Discount-Percentage charge model:\n\n* Recurring\n"
},
"isAllocationEligible": {
"type": "boolean",
"description": "This field is used to identify if the charge segment is allocation eligible in revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"specificBillingPeriod": {
"type": "integer",
"format": "int64",
"description": "Specifies the number of month or week for the charges billing period. Required if you set the value of the `billingPeriod` field to `Specific_Months` or `Specific_Weeks`.\n\nAvailable for the following charge types:\n\n* Recurring\n* Usage-based\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"description": "The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.\n\n**Note**: \n - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.\n"
},
"billingPeriodAlignment": {
"type": "string",
"description": "Aligns charges within the same subscription if multiple charges begin on different dates.\n\nValues:\n\n* `AlignToCharge`\n* `AlignToSubscriptionStart`\n* `AlignToTermStart`\n\nAvailable for the following charge types:\n\n* Recurring\n* Usage-based\n"
},
"unusedUnitsCreditRates": {
"type": "number",
"description": "Specifies the rate to credit a customer for unused units of usage. This field applies only for overage charge models when the `OverageUnusedUnitsCreditOption` field is set to `CreditBySpecificRate`.\n\nAvailable for the following charge type for the Overage and Tiered with Overage charge models:\n\n* Usage-based\n"
},
"priceIncreasePercentage": {
"type": "number",
"description": "Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the `PriceChangeOption` field to `SpecificPercentageValue`.\n\nDecimal between -100 and 100.\n\nAvailable for the following charge types:\n\n* Recurring\n* Usage-based\n\nNot available for the Fixed-Amount Discount charge model.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": ""
},
"chargeModelConfiguration": {
"$ref": "#/components/schemas/ChargeModelConfigurationType"
},
"productRatePlanChargeNumber": {
"type": "string",
"description": "Number of a product rate-plan charge for this subscription. "
},
"overageUnusedUnitsCreditOption": {
"type": "string",
"description": "Determines whether to credit the customer with unused units of usage.\n\nValues:\n\n* `NoCredit`\n* `CreditBySpecificRate`\n\nAvailable for the following charge type for the Overage and Tiered with Overage charge models:\n\n* Usage-based\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.\n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charges from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.\n"
}
}
},
{
"$ref": "#/components/schemas/RatePlanChargeObjectCustomFields"
}
],
"title": "chargeOverrides"
}
PUTScUpdateType
{
"allOf": [
{
"type": "object",
"required": [
"ratePlanChargeId"
],
"properties": {
"price": {
"type": "number",
"description": "Price for units in the subscription rate plan.\n\nSupports all charge types for the Flat Fee and Per Unit charge models\n"
},
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTTierType"
},
"description": "Container for Volume, Tiered or Tiered with Overage charge models. Supports the following charge types:\n\n* One-time\n* Recurring\n* Usage-based\n"
},
"quantity": {
"type": "number",
"description": "Quantity of units; must be greater than zero.\n"
},
"description": {
"type": "string",
"description": "Description of the charge.\n"
},
"triggerDate": {
"type": "string",
"format": "date",
"description": "Specifies when to start billing the customer for the charge. Required if the `triggerEvent` field is set to USD.\n\n`triggerDate` cannot be updated for the following using the REST update subscription call:\n\n* One-time charge type\n* Discount-Fixed Amount charge model\n* Discount-Percentage charge model\n"
},
"overagePrice": {
"type": "number",
"description": "Price for units over the allowed amount. \n\nAvailable for the following charge type for the Overage and Tiered with Overage charge models:\n\n* Usage-based\n"
},
"triggerEvent": {
"type": "string",
"description": "Specifies when to start billing the customer for the charge.\n\nValues:\n\n* `UCE`\n* `USA`\n* `UCA`\n* `USD`\n\nThis is the date when charge changes in the REST request become effective.\n\n`triggerEvent` cannot be updated for the following using the REST update subscription call:\n\n* One-time charge type\n* Discount-Fixed Amount charge model\n* Discount-Percentage charge model\n"
},
"includedUnits": {
"type": "number",
"description": "Specifies the number of units in the base set of units for this charge. Must be >=0.\n\nAvailable for the following charge type for the Overage charge model:\n* Usage-based\n"
},
"ratePlanChargeId": {
"type": "string",
"description": "ID of a rate-plan charge for this subscription. It can be the latest version or any history version of ID.\n"
},
"priceChangeOption": {
"type": "string",
"description": "Applies an automatic price change when a termed subscription is renewed. The Billing Admin setting **Enable Automatic Price Change When Subscriptions are Renewed?** must be set to Yes to use this field.\n\nValues:\n\n* `NoChange` (default)\n* `SpecificPercentageValue`\n* `UseLatestProductCatalogPricing`\n\nAvailable for the following charge types:\n\n* Recurring\n* Usage-based\n\nNot available for the Fixed-Amount Discount charge model.\n"
},
"billingPeriodAlignment": {
"type": "string",
"description": "Aligns charges within the same subscription if multiple charges begin on different dates.\n\nValues:\n\n* `AlignToCharge`\n* `AlignToSubscriptionStart`\n* `AlignToTermStart`\n\nAvailable for the following charge types:\n\n* Recurring\n* Usage-based\n"
},
"priceIncreasePercentage": {
"type": "number",
"description": "Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the `PriceChangeOption` field to `SpecificPercentageValue`.\n\nDecimal between `-100` and `100`.\n\nAvailable for the following charge types:\n\n* Recurring\n* Usage-based\n\nNot available for the Fixed-Amount Discount charge model.\n"
},
"chargeModelConfiguration": {
"$ref": "#/components/schemas/ChargeModelConfigurationType"
}
}
},
{
"$ref": "#/components/schemas/RatePlanChargeObjectCustomFields"
}
],
"title": "chargeUpdateDetails"
}
PUTSequenceSetRequest
{
"type": "object",
"example": {
"name": "FR",
"invoice": {
"startNumber": 100
},
"payment": {
"prefix": "FR-P-"
},
"creditMemo": {
"prefix": "FR-CM"
}
},
"properties": {
"name": {
"type": "string",
"description": "The name of the sequence set configured for billing documents, payments, and refunds.\n"
},
"refund": {
"$ref": "#/components/schemas/RefundEntityPrefix"
},
"invoice": {
"$ref": "#/components/schemas/InvoiceEntityPrefix"
},
"payment": {
"$ref": "#/components/schemas/PaymentEntityPrefix"
},
"debitMemo": {
"$ref": "#/components/schemas/DebitMemoEntityPrefix"
},
"creditMemo": {
"$ref": "#/components/schemas/CreditMemoEntityPrefix"
}
},
"description": ""
}
PUTSequenceSetResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded.\n"
}
},
"description": ""
}
PUTSkipPaymentScheduleItemResponse
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the newly-created payment schedule item. For example, `412880e749b72b310149b7343ef81346`.\n"
},
"amount": {
"type": "number",
"format": "decimal",
"description": "The amount of the payment.\n"
},
"number": {
"type": "string",
"description": "Number of the newly-created payment schedule item.\n"
},
"status": {
"enum": [
"Pending",
"Processed",
"Error",
"Canceled"
],
"type": "string",
"description": "ID of the payment method of the payment schedule item.\n\n- `Pending`: Waiting for processing.\n- `Processed`: The payment has been collected.\n- `Error`: Failed to collect the payment.\n- `Canceled`: After a pending payment schedule item is canceled by the user, the item is marked as `Canceled`.\n"
},
"runHour": {
"type": "integer",
"description": "At which hour in the day in the tenant’s timezone this payment will be collected.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully. \n"
},
"currency": {
"type": "string",
"description": "The currency of the payment.\n"
},
"paymentId": {
"type": "string",
"description": "ID of the payment that is created by the payment schedule item， or linked to the payment schedule item. This field is only available if the request doesn’t specify `zuora-version`, or `zuora-version` is set to a value equal to or smaller than `336.0`. \n"
},
"standalone": {
"type": "boolean",
"description": "Indicates if the payment created by the payment schedule item is a standalone payment.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the user who created the payment schedule item.\n"
},
"createdDate": {
"type": "string",
"format": "date",
"description": "The date and time when the payment schedule item was created.\n"
},
"description": {
"type": "string",
"description": "The description of the payment schedule item.\n"
},
"psiPayments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LinkedPaymentID"
},
"description": "Container for payments linked to the payment schedule item. \n"
},
"updatedById": {
"type": "string",
"description": "The ID of the user who updated the payment schedule item.\n"
},
"updatedDate": {
"type": "string",
"format": "date",
"description": "The date and time when the payment schedule item was last updated.\n"
},
"errorMessage": {
"type": "string",
"description": "The error message indicating if the error is related to the configuration or the payment collection.\n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
},
"scheduledDate": {
"type": "string",
"format": "date",
"description": "The scheduled date when the payment is processed.\n"
},
"billingDocument": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.\n"
},
"type": {
"type": "string",
"description": "Indicates whether the associated billing document is a debit memo or a invoice.\n"
},
"number": {
"type": "string",
"description": "The number of the billing docuemnt, for example, `INV00002345`.\n"
}
}
},
"paymentMethodId": {
"type": "string",
"description": "ID of the payment method of the payment schedule item.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "ID of the payment gateway of the payment schedule item.\n"
},
"paymentScheduleId": {
"type": "string",
"description": "ID of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`,\n"
},
"cancellationReason": {
"type": "string",
"description": "The reason for the cancellation of payment schedule item. \n"
},
"paymentScheduleNumber": {
"type": "string",
"description": "Number of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`,\n \n"
}
}
},
{
"$ref": "#/components/schemas/PaymentScheduleItemCustomFields"
}
]
}
PUTSrpAddType
{
"allOf": [
{
"type": "object",
"required": [
"contractEffectiveDate"
],
"properties": {
"bookingDate": {
"type": "string",
"format": "date",
"description": "The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the `yyyy-mm-dd` format. The default value is the current date when you make the API call. \n"
},
"chargeOverrides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTScAddType"
},
"description": "This optional container is used to override the quantity of one or more product rate plan charges for this subscription.\n"
},
"productRatePlanId": {
"type": "string",
"description": "ID of a product rate plan for this subscription\n"
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the amendment changes take effect. The format of the date is yyyy-mm-dd.\n\nIf there is already a future-dated Update Product amendment on the subscription, the `specificUpdateDate` field will be used instead of this field to specify when the Update Product amendment takes effect.\n"
},
"externalCatalogPlanId": {
"type": "string",
"description": "An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.\n\n**Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription\n"
},
"serviceActivationDate": {
"type": "string",
"format": "date",
"description": "The date when the new product in the subscription is activated in yyyy-mm-dd format.\n\nYou must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the `serviceActivationDate` field defaults to be the Contract Effective Date.\n\nThe billing trigger dates must follow this rule:\n\ncontractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate\n"
},
"customerAcceptanceDate": {
"type": "string",
"format": "date",
"description": "The date when the customer accepts the contract in yyyy-mm-dd format.\n\nIf this field is not set:\n\n* If the `serviceActivationDate` field is not set, the value of this field is set to be the contract effective date.\n* If the `serviceActivationDate` field is set, the value of this field is set to be the service activation date.\n\nThe billing trigger dates must follow this rule:\n\ncontractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate\n"
},
"externalIdSourceSystem": {
"type": "string",
"description": "The ID of the external source system. You can use this field and `externalCatalogPlanId` to specify a product rate plan that is imported from an external system.\n\n**Note:** If both `externalCatalogPlanId`, `externalIdSourceSystem` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.\n"
},
"externallyManagedPlanId": {
"type": "string",
"description": "Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n"
}
}
},
{
"$ref": "#/components/schemas/RatePlanObjectCustomFields"
}
],
"title": "add"
}
PUTSrpChangeType
{
"allOf": [
{
"type": "object",
"properties": {
"subType": {
"enum": [
"Upgrade",
"Downgrade",
"Crossgrade",
"PlanChanged"
],
"type": "string",
"description": "Use this field to choose the sub type for your change plan amendment. \n\nHowever, if you do not set this field, the field will be automatically generated by the system according to the following rules:\n\nWhen the old and new rate plans are within the same Grading catalog group:\n* If the grade of new plan is greater than that of the old plan, this is an \"Upgrade\".\n* If the grade of new plan is less than that of the old plan, this is a \"Downgrade\".\n* If the grade of new plan equals that of the old plan, this is a \"Crossgrade\".\n\nWhen the old and new rate plans are not in the same Grading catalog group, or either has no group, this is \"PlanChanged\".\n"
},
"resetBcd": {
"type": "boolean",
"default": false,
"description": "If resetBcd is true then reset the Account BCD to the effective date; if it is false keep the original BCD.\n"
},
"ratePlanId": {
"type": "string",
"description": "ID of a rate plan to remove. Note that the removal of a rate plan through the Change Plan amendment supports the function of <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend/E_Amendments/EB_Remove_rate_plan_on_subscription_before_future-dated_removals\" target=\"_blank\">removal before future-dated removals</a>, as in a Remove Product amendment.\n"
},
"bookingDate": {
"type": "string",
"format": "date",
"description": "The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the `yyyy-mm-dd` format. The default value is the current date when you make the API call. \n"
},
"chargeOverrides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTScAddType"
},
"description": "This optional container is used to override one or more product rate plan charges for this subscription."
},
"effectivePolicy": {
"enum": [
"EffectiveImmediately",
"EffectiveEndOfBillingPeriod",
"SpecificDate"
],
"type": "string",
"description": "The default value for the `effectivePolicy` field is as follows:\n * If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default.\n * If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default.\n * Otherwise, the effective policy is `SpecificDate` by default.\n\n**Notes**: \n * When setting this field to `EffectiveEndOfBillingPeriod`, you cannot set the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/W_Subscription_and_Amendment_Dates#Billing_Trigger_Dates\" target=\"_blank\">billing trigger dates</a> for the subscription as the system will automatically set the trigger dates to the end of billing period.\n * When setting this field to `SpecificDate`, you must also set the `contractEffectiveDate` field.\n"
},
"productRatePlanId": {
"type": "string",
"description": "ID of the product rate plan that the removed rate plan is based on.\n"
},
"newProductRatePlanId": {
"type": "string",
"description": "ID of a product rate plan for this subscription."
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "Effective date of the new subscription, as yyyy-mm-dd."
},
"externalCatalogPlanId": {
"type": "string",
"description": "An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to remove the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.\n\n**Note:** Provide only one of `externalCatalogPlanId`, `ratePlanId` or `productRatePlanId`. If more than one field is provided then the request would fail.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription. "
},
"serviceActivationDate": {
"type": "string",
"format": "date",
"description": "The date when the change in the subscription is activated in yyyy-mm-dd format. You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the `serviceActivationDate` field defaults to be the Contract Effective Date. The billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate"
},
"customerAcceptanceDate": {
"type": "string",
"format": "date",
"description": "The date when the customer accepts the contract in yyyy-mm-dd format.\nWhen this field is not set:\n* If the `serviceActivationDate` field is not set, the value of this field\nis set to be the contract effective date.\n* If the `serviceActivationDate` field is set, the value of this field is\nset to be the service activation date.\n\nThe billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate\n"
},
"externalIdSourceSystem": {
"type": "string",
"description": "The ID of the external source system. You can use this field and `externalCatalogPlanId` to specify a product rate plan that is imported from an external system.\n\n**Note:** If both `externalCatalogPlanId`, `externalIdSourceSystem` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.\n"
},
"newExternalCatalogPlanId": {
"type": "string",
"description": "An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan.\n\n**Note:** Provide only one of `newExternalCatalogPlanId` or `newProductRatePlanId`. If both fields are provided then the request would fail.\n"
},
"newProductRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription."
},
"newExternalIdSourceSystem": {
"type": "string",
"description": "The ID of the external source system. You can use this field and `newExternalCatalogPlanId` to specify a product rate plan that is imported from an external system.\n\n**Note:** If both `newExternalCatalogPlanId`, `newExternalIdSourceSystem` and `newProductRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.\n"
},
"subscriptionRatePlanNumber": {
"type": "string",
"description": "Number of a rate plan for this subscription. "
}
}
},
{
"$ref": "#/components/schemas/RatePlanObjectCustomFields"
}
],
"title": "change"
}
PUTSrpRemoveType
{
"type": "object",
"title": "remove",
"required": [
"contractEffectiveDate"
],
"properties": {
"ratePlanId": {
"type": "string",
"description": "ID of a rate plan for this subscription. This can be the latest version or any history version of ID.\n"
},
"bookingDate": {
"type": "string",
"format": "date",
"description": "The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the `yyyy-mm-dd` format. The default value is the current date when you make the API call. \n"
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "Effective date of the new subscription, as yyyy-mm-dd.\n"
},
"externalCatalogPlanId": {
"type": "string",
"description": "An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to remove the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.\n\n**Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription.\n"
},
"serviceActivationDate": {
"type": "string",
"format": "date",
"description": "The date when the remove amendment is activated in yyyy-mm-dd format.\n\nYou must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the `serviceActivationDate` field defaults to be the Contract Effective Date.\n\nThe billing trigger dates must follow this rule:\n\ncontractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate\n"
},
"customerAcceptanceDate": {
"type": "string",
"format": "date",
"description": "The date when the customer accepts the contract in yyyy-mm-dd format.\n\nIf this field is not set:\n\n* If the `serviceActivationDate` field is not set, the value of this field is set to be the contract effective date.\n* If the `serviceActivationDate` field is set, the value of this field is set to be the service activation date.\n\nThe billing trigger dates must follow this rule:\n\ncontractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate\n"
},
"externalIdSourceSystem": {
"type": "string",
"description": "The ID of the external source system. You can use this field and `externalCatalogPlanId` to specify a product rate plan that is imported from an external system.\n\n**Note:** If both `externalCatalogPlanId`, `externalIdSourceSystem` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.\n"
},
"subscriptionRatePlanNumber": {
"type": "string",
"description": "Number of a rate plan for this subscription.\n"
}
}
}
PUTSrpUpdateType
{
"allOf": [
{
"type": "object",
"required": [
"contractEffectiveDate"
],
"properties": {
"ratePlanId": {
"type": "string",
"description": "ID of a rate plan for this subscription. This can be the latest version or any history version of ID.\n"
},
"bookingDate": {
"type": "string",
"format": "date",
"description": "The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the `yyyy-mm-dd` format. The default value is the current date when you make the API call. \n"
},
"specificUpdateDate": {
"type": "string",
"format": "date",
"description": "The date when the Update Product amendment takes effect. This field is only applicable if there is already a future-dated Update Product amendment on the subscription. The format of the date is yyyy-mm-dd.\n\nRequired only for Update Product amendments if there is already a future-dated Update Product amendment on the subscription.\n"
},
"chargeUpdateDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTScUpdateType"
},
"description": "Container for one or more product rate plan charges. \n"
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the amendment changes take effect. The format of the date is yyyy-mm-dd.\n\nIf there is already a future-dated Update Product amendment on the subscription, the `specificUpdateDate` field will be used instead of this field to specify when the Update Product amendment takes effect.\n"
},
"externalCatalogPlanId": {
"type": "string",
"description": "An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.\n\n**Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription.\n"
},
"serviceActivationDate": {
"type": "string",
"format": "date",
"description": "The date when the update amendment is activated in yyyy-mm-dd format.\n\nYou must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the `serviceActivationDate` field defaults to be the Contract Effective Date.\n\nThe billing trigger dates must follow this rule:\n\ncontractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate\n"
},
"customerAcceptanceDate": {
"type": "string",
"format": "date",
"description": "The date when the customer accepts the contract in yyyy-mm-dd format.\n\nIf this field is not set:\n\n* If the `serviceActivationDate` field is not set, the value of this field is set to be the contract effective date.\n* If the `serviceActivationDate` field is set, the value of this field is set to be the service activation date.\n\nThe billing trigger dates must follow this rule:\n\ncontractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate\n"
},
"externalIdSourceSystem": {
"type": "string",
"description": "The ID of the external source system. You can use this field and `externalCatalogPlanId` to specify a product rate plan that is imported from an external system.\n\n**Note:** If both `externalCatalogPlanId`, `externalIdSourceSystem` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.\n"
},
"externallyManagedPlanId": {
"type": "string",
"description": "Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n"
},
"subscriptionRatePlanNumber": {
"type": "string",
"description": "Number of a rate plan for this subscription.\n"
}
}
},
{
"$ref": "#/components/schemas/RatePlanObjectCustomFields"
}
],
"title": "update"
}
PUTSubscriptionPatchRequestType
{
"type": "object",
"example": {
"ratePlans": [
{
"charges": [
{
"chargeNumber": "C-00000016",
"customFields": {
"sub_rpc__c": "rate plan charge custom field"
}
}
],
"ratePlanId": "8a8081085d834928015da220da08207f",
"customFields": {
"sub_rate_plan__c": "rate plan custom field"
}
}
],
"customFields": {
"sub_cf__c": "subscription custom field"
}
},
"properties": {
"ratePlans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"charges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"chargeId": {
"type": "string",
"description": "Use either this field or the `chargeNumber` field to specify the charge for which you will be updating the custom fields. By using this field you actually specify a specific charge segment of a charge. See <a href=\"https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges\" target=\"_blank\">Segmented rate plan charges</a> for more information about charge segments.\n"
},
"chargeNumber": {
"type": "string",
"description": "Use either this field or the `chargeId` field to specify the charge for which you will be updating the custom fields. By using this field you actually specify the last charge segment of a charge. See <a href=\"https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges\" target=\"_blank\">Segmented rate plan charges</a> for more information about charge segments.\n"
},
"customFields": {
"$ref": "#/components/schemas/RatePlanChargeObjectCustomFields"
}
}
}
},
"ratePlanId": {
"type": "string",
"description": "The rate plan id in any version of the subscription. This will be linked to the only one rate plan in the current version."
},
"customFields": {
"$ref": "#/components/schemas/OrdersRatePlanObjectCustomFields"
}
}
}
},
"customFields": {
"$ref": "#/components/schemas/SubscriptionObjectCustomFields"
}
}
}
PUTSubscriptionPatchSpecificVersionRequestType
{
"type": "object",
"example": {
"ratePlans": [
{
"charges": [
{
"chargeNumber": "C-00000016",
"customFields": {
"sub_rpc__c": "rate plan charge custom field"
}
}
],
"ratePlanId": "8a8081085d834928015da220da08207f",
"customFields": {
"sub_rate_plan__c": "rate plan custom field"
}
}
],
"customFields": {
"sub_cf__c": "subscription custom field"
}
},
"properties": {
"ratePlans": {
"type": "array",
"items": {
"type": "object",
"required": [
"ratePlanId"
],
"properties": {
"charges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"chargeId": {
"type": "string",
"description": "Use either this field or the `chargeNumber` field to specify the charge for which you will be updating the custom fields. By using this field you actually specify a specific charge segment of a charge. See [Segmented rate plan charges](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges) for more information about charge segments.\n"
},
"chargeNumber": {
"type": "string",
"description": "Use either this field or the `chargeId` field to specify the charge for which you will be updating the custom fields. By using this field you actually specify the last charge segment of a charge. See [Segmented rate plan charges](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges) for more information about charge segments.\n"
},
"customFields": {
"$ref": "#/components/schemas/RatePlanChargeObjectCustomFields"
}
}
}
},
"ratePlanId": {
"type": "string",
"description": "The rate plan id in any version of the subscription. This will be linked to the only one rate plan in the current version."
},
"customFields": {
"$ref": "#/components/schemas/RatePlanObjectCustomFields"
}
}
}
},
"customFields": {
"$ref": "#/components/schemas/SubscriptionObjectCustomFields"
}
}
}
PUTSubscriptionPreviewInvoiceItemsType
{
"type": "object",
"title": "invoiceItems",
"properties": {
"quantity": {
"type": "number",
"description": "Quantity of this item.\n"
},
"chargeName": {
"type": "string",
"description": "Name of the charge\n"
},
"productName": {
"type": "string",
"description": "Name of the product associated with this item.\n"
},
"chargeAmount": {
"type": "number",
"description": "The amount of the charge. This amount doesn't include taxes unless the charge's tax mode is inclusive.\n"
},
"taxationItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTSubscriptionPreviewTaxationItemsType"
},
"description": "List of taxation items.\n**Note**: This field is only available if you set the `zuora-version` request header to `315.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). "
},
"unitOfMeasure": {
"type": "string",
"description": ""
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge.\n"
},
"chargeDescription": {
"type": "string",
"description": "Description of the charge.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": ""
}
}
}
PUTSubscriptionResponseType
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Invoice amount. Preview mode only.\n"
},
"invoice": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "Invoice amount."
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The tax amount of the invoice.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.\n\n**Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTSubscriptionPreviewInvoiceItemsType"
},
"description": "Container for invoice items.\n"
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "Invoice amount minus tax.\n"
}
},
"description": "Container for invoices.\n\n\n **Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header. Also, the response structure is changed and the following invoice related response fields are moved to this **invoice** container:\n \n * amount\n * amountWithoutTax\n * taxAmount\n * invoiceItems\n * targetDate\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"invoiceId": {
"type": "string",
"description": "Invoice ID, if an invoice is generated during the update.\n"
},
"paymentId": {
"type": "string",
"description": "Payment ID, if a payment is collected.\n"
},
"taxAmount": {
"type": "number",
"description": "Tax amount on the invoice.\n"
},
"creditMemo": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "Credit memo amount."
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "Tax amount on the credit memo."
},
"creditMemoItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/POSTSubscriptionPreviewCreditMemoItemsType"
},
"description": ""
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "Credit memo amount minus tax."
}
},
"description": "Container for credit memos.\n\n**Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, and 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n"
},
"paidAmount": {
"type": "number",
"description": "Payment amount, if a payment is collected\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.\n\n**Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header.\n"
},
"creditMemoId": {
"type": "string",
"description": "The credit memo ID, if a credit memo is generated during the subscription process.\n\n**Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, and 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTSubscriptionPreviewInvoiceItemsType"
},
"description": "Container for invoice items.\n"
},
"chargeMetrics": {
"type": "object",
"properties": {
"mrr": {
"type": "string",
"description": "Monthly recurring revenue.\n"
},
"tcv": {
"type": "string",
"description": "Total contract value.\n"
},
"dmrr": {
"type": "string",
"description": "Change in total contract value.\n"
},
"dtcv": {
"type": "string",
"description": "Change in monthly recurring revenue.\n"
},
"number": {
"type": "string",
"description": "The charge number of the subscription. Only available for update subscription.\n"
},
"originalId": {
"type": "string",
"description": "The original rate plan charge ID. Only available for update subscription.\n"
},
"originRatePlanId": {
"type": "string",
"description": "The origin rate plan ID. Only available for update subscription.\n"
},
"productRatePlanId": {
"type": "string",
"description": ""
},
"productRatePlanChargeId": {
"type": "string",
"description": ""
}
},
"description": "Container for charge metrics.\n"
},
"totalDeltaMrr": {
"type": "number",
"description": "Change in the subscription monthly recurring revenue as a result of the update.\n"
},
"totalDeltaTcv": {
"type": "number",
"description": "Change in the total contracted value of the subscription as a result of the update.\n"
},
"subscriptionId": {
"type": "string",
"description": "The ID of the resulting new subscription.\n"
},
"amountWithoutTax": {
"type": "number",
"description": "Invoice amount minus tax. Preview mode only.\n"
},
"invoiceTargetDate": {
"type": "string",
"format": "date",
"description": "Date through which charges are calculated on the invoice, as yyyy-mm-dd. Preview mode only.\n\n**Note:** This field is only available if you do not specify the Zuora REST API minor version or specify the minor version to 186.0, 187.0, 188.0, 189.0, and 196.0. .\n"
}
}
}
PUTSubscriptionResumeResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"invoiceId": {
"type": "string",
"description": "Invoice ID, if an invoice is generated during the subscription process.\n"
},
"paymentId": {
"type": "string",
"description": "Payment ID, if a payment is collected.\n"
},
"paidAmount": {
"type": "number",
"description": "Payment amount, if a payment is collected.\n"
},
"resumeDate": {
"type": "string",
"format": "date",
"description": "The date when subscription resumption takes effect, as yyyy-mm-dd.\n"
},
"termEndDate": {
"type": "string",
"format": "date",
"description": "The date when the new subscription term ends, as yyyy-mm-dd.\n"
},
"creditMemoId": {
"type": "string",
"description": "The credit memo ID, if a credit memo is generated during the subscription process.\n\n**Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, and 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"totalDeltaTcv": {
"type": "number",
"description": "Change in the total contracted value of the subscription as a result of the update.\n"
},
"subscriptionId": {
"type": "string",
"description": "The subscription ID.\n"
}
}
}
PUTSubscriptionResumeType
{
"type": "object",
"example": {
"collect": false,
"runBilling": true,
"extendsTerm": true,
"resumePolicy": "SpecificDate",
"resumeSpecificDate": "2019-10-01",
"creditMemoReasonCode": "Unsatisfactory service",
"contractEffectiveDate": "2019-02-01"
},
"required": [
"resumePolicy"
],
"properties": {
"collect": {
"type": "boolean",
"default": false,
"description": "Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.\n\nIf the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.\n\nPrerequisite: The `invoice` or `runBilling` field must be `true`. \n\n**Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"invoice": {
"type": "boolean",
"description": "**Note:** This field has been replaced by the `runBilling` field. The\n`invoice` field is only available for backward compatibility.\n\n\nCreates an invoice for a subscription. The invoice generated in this\noperation is only for this subscription, not for the entire customer\naccount.\n\n\nIf the value is `true`, an invoice is created. If the value is\n`false`, no action is taken. The default value is `false`.\n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `196.0` and `207.0`. To use this field in the method, you\nmust set the `zuora-version` parameter to the minor version number in\nthe request header.\n"
},
"orderDate": {
"type": "string",
"format": "date",
"description": "The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date.\nThis field must be in the `yyyy-mm-dd` format.\nThis field is required for Orders customers only, not applicable to Orders Harmonization customers.\n"
},
"runBilling": {
"enum": [
true,
false
],
"type": "boolean",
"default": false,
"description": "Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos). \n\n\nThe billing documents generated\nin this operation is only for this subscription, not for the entire\ncustomer account.\n\n\nPossible values:\n\n- `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.\n\n\n- `false`: No invoice is created.\n\n\n**Note:** This field is in Zuora REST API version control. Supported\nminor versions are `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). To use this field in the method,\nyou must set the `zuora-version` parameter to the minor version number\nin the request header.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice or a credit memo is generated, as\nyyyy-mm-dd. Default is current date.\n\n\n**Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.\n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `211.0` and later. To use this field in the method, you\nmust set the `zuora-version` parameter to the minor version number in\nthe request header.\n"
},
"applyCredit": {
"type": "boolean",
"description": "If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.\n\n**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"bookingDate": {
"type": "string",
"format": "date",
"description": "The booking date that you want to set for the amendment contract when you resume the subscription. If `extendsTerm` is `true`, which means you also extend the term, then this field is also the booking date for the Terms and Conditions amendment contract.\n\nThis field must be in the `yyyy-mm-dd` format. The default value of this field is the current date when you make the API call. \n"
},
"extendsTerm": {
"type": "boolean",
"description": "Whether to extend the subscription term by the length of time the suspension is in effect.\n\nValues: `true`, `false`.\n"
},
"documentDate": {
"type": "string",
"format": "date",
"description": "The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.\n\n- If this field is specified, the specified date is used as the billing document date. \n- If this field is not specified, the date specified in the `targetDate` is used as the billing document date.\n"
},
"resumePolicy": {
"type": "string",
"description": "Resume methods. Specify a way to resume a subscription.\n\nValues:\n\n* `Today`: The subscription resumption takes effect on today's date.\n\n* `FixedPeriodsFromSuspendDate`: The subscription resumption takes effect after a specified period based on the suspend date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period.\n\n* `SpecificDate`: The subscription resumption takes effect on a specific date. You must define the specific date in the `resumeSpecificDate` field.\n\n* `FixedPeriodsFromToday`: The subscription resumption takes effect after a specified period based on the today's date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period.\n* `suspendDate`: The subscription resumption takes effect on the date of suspension of the subscription.\n"
},
"resumePeriods": {
"type": "string",
"description": "The length of the period used to specify when the subscription is resumed. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the `resumePeriodsType` field to specify the period.\n\n**Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`.\n"
},
"invoiceCollect": {
"type": "boolean",
"default": false,
"description": "**Note:** This field has been replaced by the `invoice` field\nand the `collect` field. `invoiceCollect` is available only for backward\ncompatibility.\n\n\nIf `true`, an invoice is generated and payment collected automatically during\nthe subscription process. If `false`, no invoicing or payment\ntakes place. The invoice generated in this operation is only for this subscription,\nnot for the entire customer account.\n\n\n**Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`.\n"
},
"applicationOrder": {
"type": "array",
"items": {
"type": "string"
},
"description": "The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.\n\n**Note:**\n - This field is valid only if the `applyCredit` field is set to `true`.\n - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.\n - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.\n"
},
"invoiceTargetDate": {
"type": "string",
"format": "date",
"description": "**Note:** This field has been replaced by the `targetDate` field. The\n`invoiceTargetDate` field is only available for backward\ncompatibility.\n\n\nDate through which to calculate charges if an invoice is generated, as\nyyyy-mm-dd. Default is current date.\n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `207.0` and earlier [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"resumePeriodsType": {
"type": "string",
"description": "The period type used to define when the subscription resumption takes effect. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the `resumePeriods` field to specify the period.\n\nValues: `Day`, `Week`, `Month`, `Year`\n\n**Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`.\n"
},
"applyCreditBalance": {
"type": "boolean",
"description": "Whether to automatically apply a credit balance to an invoice.\n\nIf the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.\n\n\nTo view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.\n\nPrerequisite: `invoice` must be `true`. \n\n**Note:** \n - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.\n - This field is deprecated if you have the Invoice Settlement feature enabled.\n"
},
"resumeSpecificDate": {
"type": "string",
"format": "date",
"description": "A specific date when the subscription resumption takes effect, in the format yyyy-mm-dd.\n\n**Note:** This field is only applicable only when the `resumePolicy` field is set to `SpecificDate`.\n\nThe value should not be earlier than the subscription suspension date.\n"
},
"creditMemoReasonCode": {
"type": "string",
"description": "A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code."
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the customer notifies you that they want to resume their subscription.\n"
}
}
}
PUTSubscriptionSuspendResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"invoiceId": {
"type": "string",
"description": "Invoice ID, if an invoice is generated during the subscription process.\n"
},
"paymentId": {
"type": "string",
"description": "Payment ID, if a payment is collected.\n"
},
"paidAmount": {
"type": "number",
"description": "Payment amount, if a payment is collected.\n"
},
"resumeDate": {
"type": "string",
"format": "date",
"description": "The date when subscription resumption takes effect, in the format yyyy-mm-dd.\n"
},
"suspendDate": {
"type": "string",
"format": "date",
"description": "The date when subscription suspension takes effect, in the format yyyy-mm-dd.\n"
},
"termEndDate": {
"type": "string",
"format": "date",
"description": "The date when the new subscription term ends, in the format yyyy-mm-dd.\n"
},
"creditMemoId": {
"type": "string",
"description": "The credit memo ID, if a credit memo is generated during the subscription process.\n\n**Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, and 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"totalDeltaTcv": {
"type": "number",
"description": "Change in the total contracted value of the subscription as a result of the update.\n"
},
"subscriptionId": {
"type": "string",
"description": "The subscription ID.\n"
}
}
}
PUTSubscriptionSuspendType
{
"type": "object",
"example": {
"resume": true,
"collect": false,
"runBilling": true,
"extendsTerm": true,
"resumePolicy": "SpecificDate",
"suspendPolicy": "FixedPeriodsFromToday",
"suspendPeriods": 10,
"resumeSpecificDate": "2019-06-01",
"suspendPeriodsType": "Day",
"creditMemoReasonCode": "Unsatisfactory service",
"contractEffectiveDate": "2019-02-01"
},
"required": [
"suspendPolicy"
],
"properties": {
"resume": {
"type": "boolean",
"description": "Whether to set when to resume a subscription when creating a suspend amendment. Values: `true`, `false`.\n"
},
"collect": {
"type": "boolean",
"default": false,
"description": "Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.\n\nIf the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.\n\nPrerequisite: The `invoice` or `runBilling` field must be `true`. \n\n**Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"invoice": {
"type": "boolean",
"description": "**Note:** This field has been replaced by the `runBilling` field. The\n`invoice` field is only available for backward compatibility.\n\n\nCreates an invoice for a subscription. The invoice generated in this\noperation is only for this subscription, not for the entire customer\naccount.\n\n\nIf the value is `true`, an invoice is created. If the value is\n`false`, no action is taken. The default value is `false`. \n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `196.0` and `207.0`. To use this field in the method, you\nmust set the zuora-version parameter to the minor version number in\nthe request header.\n"
},
"orderDate": {
"type": "string",
"format": "date",
"description": "The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date.\nThis field must be in the `yyyy-mm-dd` format.\nThis field is required for Orders customers only, not applicable to Orders Harmonization customers.\n"
},
"runBilling": {
"enum": [
true,
false
],
"type": "boolean",
"default": false,
"description": "Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos). \n\n\nThe billing documents generated\nin this operation is only for this subscription, not for the entire\ncustomer account.\n\n\nPossible values:\n\n- `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.\n\n\n- `false`: No invoice is created.\n\n\n**Note:** This field is in Zuora REST API version control. Supported\nminor versions are `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). To use this field in the method,\nyou must set the `zuora-version` parameter to the minor version number\nin the request header.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice or a credit memo is generated, as\nyyyy-mm-dd. Default is current date.\n\n\n**Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.\n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `211.0` and later. To use this field in the method, you\nmust set the `zuora-version` parameter to the minor version number in\nthe request header.\n"
},
"applyCredit": {
"type": "boolean",
"description": "If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices.\n\n\n**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"bookingDate": {
"type": "string",
"format": "date",
"description": "The booking date that you want to set for the amendment contract when you suspend the subscription. If `resume` is `true`, which means you also choose to resume the subscription at some point, then this field is also the booking date for the Resume amendment contract.\n\nThis field must be in the `yyyy-mm-dd` format. The default value of this field is the current date when you make the API call. \n"
},
"extendsTerm": {
"type": "boolean",
"description": "Whether to extend the subscription term by the length of time the suspension is in effect. Values: `true`, `false`.\n"
},
"documentDate": {
"type": "string",
"format": "date",
"description": "The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.\n\n- If this field is specified, the specified date is used as the billing document date. \n- If this field is not specified, the date specified in the `targetDate` is used as the billing document date.\n"
},
"resumePolicy": {
"type": "string",
"description": "Resume methods. Specify a way to resume a subscription. Values:\n\n* `Today`: The subscription resumption takes effect on today's date.\n\n* `FixedPeriodsFromSuspendDate`: The subscription resumption takes effect after a specified period based on the suspend date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period.\n\n* `SpecificDate`: The subscription resumption takes effect on a specific date. You must define the specific date in the `resumeSpecificDate` field.\n\n* `FixedPeriodsFromToday`: The subscription resumption takes effect after a specified period based on the today's date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period.\n* `suspendDate`: The subscription resumption takes effect on the date of suspension of the subscription.\n"
},
"resumePeriods": {
"type": "string",
"description": "The length of the period used to specify when the subscription is resumed. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the `resumePeriodsType` field to specify the period.\n\n**Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`.\n"
},
"suspendPolicy": {
"type": "string",
"description": "Suspend methods. Specify a way to suspend a subscription. \n\nValue:\n\n* `Today`: The subscription suspension takes effect on today's date.\n* `EndOfLastInvoicePeriod`: The subscription suspension takes effect at the end of the last invoice period. The suspend date defaults to a date that is one day after the last invoiced period. You can choose this option to avoid any negative invoices (credits) issued back to the customer after the subscription suspension. \n* `SpecificDate`: The subscription suspension takes effect on a specific date. You must define the specific date in the `suspendSpecificDate` field.\n* `FixedPeriodsFromToday`: The subscription suspension takes effect after a specified period based on today's date. You must specify the `suspendPeriods` and `suspendPeriodsType` fields to define the period.\n"
},
"invoiceCollect": {
"type": "boolean",
"description": "**Note:** This field has been replaced by the `invoice` field\nand the `collect` field. `invoiceCollect` is available only for backward\ncompatibility.\n\n\n**Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`.\n"
},
"suspendPeriods": {
"type": "string",
"description": "The length of the period used to specify when the subscription suspension takes effect. The subscription suspension takes effect after a specified period based on today's date. You must use this field together with the `suspendPeriodsType` field to specify the period.\n\n**Note:** This field is only applicable only when the suspendPolicy field is set to FixedPeriodsFromToday.\n"
},
"applicationOrder": {
"type": "array",
"items": {
"type": "string"
},
"description": "The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.\n\n**Note:**\n - This field is valid only if the `applyCredit` field is set to `true`.\n - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.\n - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.\n"
},
"invoiceTargetDate": {
"type": "string",
"format": "date",
"description": "**Note:** This field has been replaced by the `targetDate` field. The\n`invoiceTargetDate` field is only available for backward\ncompatibility.\n\n\nDate through which to calculate charges if an invoice is generated, as\nyyyy-mm-dd. Default is current date.\n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `207.0` and earlier [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"resumePeriodsType": {
"type": "string",
"description": "The period type used to define when the subscription resumption takes effect. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the resumePeriods field to specify the period.\n\nValues: `Day`, `Week`, `Month`, `Year`\n\n**Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`.\n"
},
"applyCreditBalance": {
"type": "boolean",
"description": "Whether to automatically apply a credit balance to an invoice.\n\nIf the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.\n\n\nTo view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.\n\nPrerequisite: `invoice` must be `true`. \n\n**Note:** \n - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.\n - This field is deprecated if you have the Invoice Settlement feature enabled.\n"
},
"resumeSpecificDate": {
"type": "string",
"format": "date",
"description": "A specific date when the subscription resumption takes effect, in the format yyyy-mm-dd.\n\n**Note:** This field is only applicable only when the `resumePolicy` field is set to `SpecificDate`.\n\nThe value should not be earlier than the subscription suspension date.\n"
},
"suspendPeriodsType": {
"type": "string",
"description": "The period type used to define when the subscription suspension takes effect. The subscription suspension takes effect after a specified period based on today's date. You must use this field together with the suspendPeriods field to specify the period.\n\nType: string (enum)\n\nValues: `Day`, `Week`, `Month`, `Year`\n\n**Note:** This field is only applicable only when the suspendPolicy field is set to FixedPeriodsFromToday.\n"
},
"suspendSpecificDate": {
"type": "string",
"format": "date",
"description": "A specific date when the subscription suspension takes effect, in the format yyyy-mm-dd.\n\n**Note:** This field is only applicable only when the suspendPolicy field is set to SpecificDate.\n\nThe value should not be earlier than the subscription contract effective date, later than the subscription term end date, or within a period for which the customer has been invoiced.\n"
},
"creditMemoReasonCode": {
"type": "string",
"description": "A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code."
},
"contractEffectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the customer notifies you that they want to amend their subscription.\n"
}
}
}
PUTSubscriptionType
{
"allOf": [
{
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTSrpAddType"
},
"description": "Container for adding one or more rate plans.\n"
},
"notes": {
"type": "string",
"description": "String of up to 500 characters.\n"
},
"change": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTSrpChangeType"
},
"description": "Use this field to change one or more rate plans - to replace the existing rate plans in a subscription with other rate plans.\n\n**Note**: Changing rate plans is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, changing rate plans will no longer be applicable in Zuora Billing.\n"
},
"remove": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTSrpRemoveType"
},
"description": "Container for removing one or more rate plans.\n"
},
"update": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PUTSrpUpdateType"
},
"description": "Container for updating one or more rate plans.\n"
},
"collect": {
"type": "boolean",
"default": false,
"description": "Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account.\n\nIf the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken.\n\nPrerequisite: The `invoice` or `runBilling` field must be `true`. \n\n**Note**: This field is only available if you set the `zuora-version` request header to `196.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"invoice": {
"type": "boolean",
"description": "**Note:** This field has been replaced by the `runBilling` field. The\n`invoice` field is only available for backward compatibility.\n\n\nCreates an invoice for a subscription. The invoice generated in this\noperation is only for this subscription, not for the entire customer\naccount.\n\n\nIf the value is `true`, an invoice is created. If the value is\n`false`, no action is taken. The default value is `false`. \n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `196.0` and `207.0`. To use this field in the method, you\nmust set the zuora-version parameter to the minor version number in\nthe request header.\n"
},
"preview": {
"type": "boolean",
"description": "If `true` the update is made in preview mode. The default setting is `false`.\n"
},
"termType": {
"type": "string",
"description": "Possible values are: `TERMED`, `EVERGREEN`.\n"
},
"autoRenew": {
"type": "boolean",
"description": "If `true`, this subscription automatically renews at the end of the subscription term. Default is `false`.\n"
},
"runBilling": {
"enum": [
true,
false
],
"type": "boolean",
"default": false,
"description": "Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos). \n\n\nThe billing documents generated\nin this operation is only for this subscription, not for the entire\ncustomer account.\n\n\nPossible values:\n\n- `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created.\n\n\n- `false`: No invoice is created.\n\n\n**Note:** This field is in Zuora REST API version control. Supported\nminor versions are `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). To use this field in the method,\nyou must set the `zuora-version` parameter to the minor version number\nin the request header.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice or a credit memo is generated, as\nyyyy-mm-dd. Default is current date.\n\n\n**Note:** The credit memo is only available if you have the Invoice Settlement feature enabled.\n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `211.0` and later. To use this field in the method, you\nmust set the `zuora-version` parameter to the minor version number in\nthe request header.\n"
},
"applyCredit": {
"type": "boolean",
"description": "Whether to automatically apply credit memos or unapplied payments, or both to an invoice.\n\nIf the value is `true`, the credit memo or unapplied payment, or both will be automatically applied to the invoice. If no value is specified or the value is `false`, no action is taken.\n\n**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"bookingDate": {
"type": "string",
"format": "date",
"description": "The booking date that you want to set for the contract when you change the `termType` field of the subscription and as a result get a new version of subscription created. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the `yyyy-mm-dd` format. The default value is the current date when you make the API call. \n"
},
"currentTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the current subscription term. If `termType` is `TERMED`, this field is required and must be greater than `0`. If `termType` is `EVERGREEN`, this value is ignored.\n"
},
"previewType": {
"type": "string",
"description": "The type of preview you will receive. \n\nThis field is in Zuora REST API version control. The supported values of this field depend on the REST API minor version you specified in the request header.\n\n\n* If you do not specify the REST API minor version or specify the minor version number to one of following values in the request header:\n\n * 186.0\n * 187.0\n * 188.0\n * 189.0\n * 196.0\n * 206.0\n\n The following values are supported in the **previewType** field:\n\n * InvoiceItem\n * ChargeMetrics\n * InvoiceItemChargeMetrics\n\n The default value is InvoiceItem.\n\n* If you specify the REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, the following values are supported in the **previewType** field:\n\n - LegalDoc\n - ChargeMetrics\n - LegalDocChargeMetrics\n\n The default value is LegalDoc.\n\n.\n"
},
"renewalTerm": {
"type": "integer",
"format": "int64",
"description": "The length of the period for the subscription renewal term. Default is `0`.\n"
},
"documentDate": {
"type": "string",
"format": "date",
"description": "The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.\n\n- If this field is specified, the specified date is used as the billing document date. \n- If this field is not specified, the date specified in the `targetDate` is used as the billing document date.\n"
},
"termStartDate": {
"type": "string",
"format": "date",
"description": "Date the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date. \n"
},
"invoiceCollect": {
"type": "boolean",
"default": false,
"description": "**Note:** This field has been replaced by the `invoice` field\nand the `collect` field. `invoiceCollect` is available only for backward\ncompatibility.\n\n\nIf `true`, an invoice is generated and payment collected automatically during\nthe subscription process. If `false`, no invoicing or payment\ntakes place. The invoice generated in this operation is only for this subscription,\nnot for the entire customer account.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `186.0`, `187.0`, `188.0`, or `189.0`.\n"
},
"renewalSetting": {
"type": "string",
"description": "Specifies whether a termed subscription will remain `TERMED` or change to `EVERGREEN` when it is renewed. \n\nValues are:\n\n* `RENEW_WITH_SPECIFIC_TERM` (default)\n* `RENEW_TO_EVERGREEN`\n"
},
"applicationOrder": {
"type": "array",
"items": {
"type": "string"
},
"description": "The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.\n\n**Note:**\n - This field is valid only if the `applyCredit` field is set to `true`.\n - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.\n - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.\n"
},
"invoiceSeparately": {
"type": "boolean",
"description": "Separates a single subscription from other subscriptions and invoices the charge independently. \n\nIf the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice.\n\nThe default value is `false`.\nPrerequisite: The default subscription setting Enable Subscriptions to be Invoiced Separately must be set to Yes.\n"
},
"invoiceTargetDate": {
"type": "string",
"format": "date",
"description": "**Note:** This field has been replaced by the `targetDate` field. The\n`invoiceTargetDate` field is only available for backward\ncompatibility.\n\n\nDate through which to calculate charges if an invoice is generated, as\nyyyy-mm-dd. Default is current date.\n\n\nThis field is in Zuora REST API version control. Supported minor\nversions are `207.0` and earlier [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"applyCreditBalance": {
"type": "boolean",
"description": "Whether to automatically apply a credit balance to an invoice.\n\nIf the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken.\n\n\nTo view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method.\n\nPrerequisite: `invoice` must be `true`. \n\n**Note:** \n - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.\n - This field is deprecated if you have the Invoice Settlement feature enabled.\n"
},
"externallyManagedBy": {
"enum": [
"Amazon",
"Apple",
"Google",
"Roku"
],
"type": "string",
"description": "An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores.\n"
},
"creditMemoReasonCode": {
"type": "string",
"description": "A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code."
},
"currentTermPeriodType": {
"type": "string",
"description": "The period type for the current subscription term.\n\nThis field is used with the `CurrentTerm` field to specify the current subscription term.\n\nValues are:\n\n* `Month` (default)\n* `Year`\n* `Day`\n* `Week`\n"
},
"renewalTermPeriodType": {
"type": "string",
"description": "\nThe period type for the subscription renewal term.\n\nThis field is used with the `renewalTerm` field to specify the subscription renewal term.\n\nValues are:\n\n* `Month` (default)\n* `Year`\n* `Day`\n* `Week`\n"
},
"includeExistingDraftDocItems": {
"type": "boolean",
"description": "Specifies whether to include draft invoice items in subscription previews.\nValues are:\n\n* `true` (default). Includes draft invoice items in the preview result.\n* `false`. Excludes draft invoice items in the preview result.\n\n**Note:** This field is in Zuora REST API version control. Supported minor versions are 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). To use this field in the method, you must set the **zuora-version** parameter to the minor version number in the request header.\n"
},
"includeExistingDraftInvoiceItems": {
"type": "boolean",
"description": "Specifies whether to include draft invoice items in subscription previews.\nValues are:\n\n* `true` (default). Includes draft invoice items in the preview result.\n* `false`. Excludes draft invoice items in the preview result.\n\n**Note:** This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. .\n"
}
}
},
{
"$ref": "#/components/schemas/SubscriptionObjectQTFields"
},
{
"$ref": "#/components/schemas/SubscriptionObjectNSFields"
},
{
"$ref": "#/components/schemas/SubscriptionObjectCustomFields"
}
],
"example": {
"notes": "Test UPDATE subscription from z-ruby-sdk",
"update": [
{
"ratePlanId": "2c92c8f83dcbd8b1013dcce0ea7e006f",
"bookingDate": "2022-01-02",
"chargeUpdateDetails": [
{
"quantity": 12,
"ratePlanChargeId": "2c92c8f83dcbd8b1013dcce0eb510075"
}
],
"contractEffectiveDate": "2013-04-28"
}
],
"collect": false,
"termType": "TERMED",
"autoRenew": false,
"runBilling": true,
"bookingDate": "2022-01-01",
"currentTerm": "10",
"renewalTerm": "4",
"renewalSetting": "RENEW_WITH_SPECIFIC_TERM",
"creditMemoReasonCode": "Unsatisfactory service",
"currentTermPeriodType": "Month",
"renewalTermPeriodType": "Month"
}
}
PUTTaxationItemType
{
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the taxation item to be updated.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific credit or debit memo.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date when the tax is applied to the credit or debit memo.\n"
},
"taxRate": {
"type": "number",
"format": "double",
"description": "The tax rate applied to the credit or debit memo.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The amount of the tax applied to the credit or debit memo.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate applied to the credit or debit memo.\n"
},
"exemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field. \n"
},
"financeInformation": {
"type": "object",
"properties": {
"onAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"salesTaxPayableAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the sales taxes payable.\n"
}
},
"description": "Container for the finance information related to the taxation item.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate. \n"
}
}
},
{
"$ref": "#/components/schemas/TaxationItemObjectCustomFields"
}
],
"example": {
"name": "STATE TAX",
"taxCode": "ServiceTaxCode",
"taxDate": "2016-06-05",
"taxRate": 0.0625,
"taxAmount": 1,
"taxRateType": "Percentage",
"exemptAmount": 0,
"jurisdiction": "CALIFORNIA",
"locationCode": "06",
"financeInformation": {
"onAccountAccountingCode": "Check",
"salesTaxPayableAccountingCode": ""
},
"taxCodeDescription": "This is tax code description!",
"taxRateDescription": "This is tax rate description!"
}
}
PUTUpdateInvoiceScheduleRequest
{
"allOf": [
{
"type": "object",
"properties": {
"notes": {
"type": "string",
"maxLength": 255,
"description": "Comments on the invoice schedule.\n"
},
"orders": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of the IDs or numbers of the orders associated with the invoice schedule. One invoice schedule can be associated with at most 10 orders.\n\nThe orders specified in this field override all the existing orders associated with the invoice schedule.\n"
},
"nextRunDate": {
"type": "string",
"format": "date",
"description": "The run date of the next execution of the invoice schedule. \n\nBy default, the next run date is the same as the run date of next pending invoice schedule item. The date can be overwritten by a different date other than the default value. If the invoice schedule has completed the execution, the next run date is `null`.\n"
},
"scheduleItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateScheduleItems"
},
"description": "Container for invoice schedule items. The maximum number of schedule items is 50.\n\nThe invoice schedule items specified in this field override all the existing invoice schedule items.\n"
},
"invoiceSeparately": {
"type": "boolean",
"description": "Whether the invoice items created from the invoice schedule appears on a separate invoice when Zuora generates invoices.\n"
},
"specificSubscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceScheduleSpecificSubscriptions"
},
"description": "A list of the numbers of specific subscriptions associated with the invoice schedule.\n\n- If the subscriptions specified in this field belong to the orders specified in the `orders` field, only the specific subscriptions instead of the orders are associated with the invoice schedule. \n- If only the `orders` field is specified, all the subscriptions from the order are associated with the invoice schedule.\n \nThe specific subscriptions specified in this field override all the existing specific subscriptions associated with the invoice schedule.\n\nExample:\n```\n{\n \"orders\": [\n \"O-00000001\", \"O-00000002\"\n ],\n \"specificSubscriptions\": [\n {\n \"orderKey\": \"O-00000001\",\n \"subscriptionKey\": \"S-00000001\"\n }\n ]\n}\n```\n- For the order with number O-00000001, only subscription S-00000001 contained in the order is associated with the invoice schedule.\n- For the order with number O-00000002, all subscriptions contained in the order are associated with the invoice schedule.\n"
},
"additionalSubscriptionsToBill": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of the numbers of the subscriptions that need to be billed together with the invoice schedule. \n\nOne invoice schedule can have at most 600 additional subscriptions.\n"
}
}
},
{
"$ref": "#/components/schemas/InvoiceScheduleCustomFields"
},
{}
],
"example": {
"notes": "2022 Billing Schedule - V2",
"orders": [
"O-00000007",
"O-00000008"
],
"nextRunDate": "2022-02-01",
"scheduleItems": [
{
"id": "8a8881aa82118bec018211daf9f01680X",
"amount": 54000,
"runDate": "2022-02-24",
"targetDateForAdditionalSubscriptions": "2022-02-24"
},
{
"id": "8a8881aa82118bec018211daf9f11681X",
"amount": 10000,
"runDate": "2022-10-17",
"targetDateForAdditionalSubscriptions": "2022-10-17"
},
{
"id": "8a8881aa82118bec018211daf9f11682X",
"amount": 6200,
"runDate": "2022-11-14",
"targetDateForAdditionalSubscriptions": "2022-11-14"
}
],
"invoiceSeparately": false,
"specificSubscriptions": [
{
"orderKey": "O-00000008",
"subscriptionKey": "S-00000008"
}
],
"additionalSubscriptionsToBill": [
"S-00000001",
"S-00000002"
]
}
}
PUTUpdateOpenPaymentMethodTypeRequest
{
"example": {
"label": "ZuoraQA Amazon Pay",
"fields": [
{
"name": "AmazonToken",
"type": "string",
"index": 1,
"label": "AmazonToken",
"visible": true,
"checksum": true,
"editable": true,
"required": true,
"maxLength": 100,
"minLength": 1,
"description": "The Token value",
"representer": true,
"defaultValue": null
},
{
"name": "AmazonTokenType",
"type": "string",
"index": 2,
"label": "Amazon TokenType",
"visible": true,
"checksum": true,
"editable": true,
"required": true,
"maxLength": 100,
"minLength": 1,
"description": "The Type of Token, e.g. GoCardlessToken",
"representer": true,
"defaultValue": null
}
],
"entityId": "",
"tenantId": "9",
"internalName": "AmazonPay",
"subTypeField": "AmazonTokenType",
"userReferenceIdField": "",
"methodReferenceIdField": "AmazonToken"
},
"required": [
"internalName",
"tenantId",
"label",
"methodReferenceIdField",
"fields"
],
"properties": {
"label": {
"type": "string",
"maxLength": 40,
"description": "The label that is used to refer to this type in the Zuora UI.\n\nThis value must be alphanumeric, excluding JSON preserved characters such as * \\ ’ ” \n"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OpenPaymentMethodTypeRequestFields"
},
"description": "An array containing field metadata of the custom payment method type.\n\nNotes:\n - All the following nested metadata fields must be provided in the request to define a field. \n - At least one field must be defined in the fields array for a custom payment method type. \n - Up to 20 fields can be defined in the fields array for a custom method type.\n"
},
"entityId": {
"type": "string",
"description": "If this custom payment method type is specific to one entity only, specify the entity ID in UUID format when creating the draft payment method type, such as `123e4567-e89b-12d3-a456-426614174000`.\n\nYou can only update this field to be empty, indicating that this custom payment method type is available to the global entity and all the sub entities in the tenant.\n"
},
"tenantId": {
"type": "string",
"description": "Zuora tenant ID. If multi-entity is enabled in your tenant, this is the ID of the parent tenant of all the sub entities.\n\nThis field cannot be updated after the creation of the custom payment method type.\n"
},
"internalName": {
"type": "string",
"maxLength": 19,
"description": "A string to identify the custom payment method type in the API name of the payment method type.\n\nThe value of this field must be the same as the value specified when creating the draft revision of this custom payment method type.\n\nThis field cannot be updated after the creation of the custom payment method type.\n\nThis field is used along with the `tenantId` field by the system to construct and generate the API name of the custom payment method type in the following way:\n\n`<internalName>__c_<tenantId>`\n\nFor example, if `internalName` is `AmazonPay`, and `tenantId` is `12368`, the API name of the custom payment method type will be `AmazonPay__c_12368`.\n"
},
"subTypeField": {
"type": "string",
"description": "The identification reference indicating the subtype of the custom payment method.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.\n\nThis field cannot be updated after the creation of the custom payment method type.\n"
},
"userReferenceIdField": {
"type": "string",
"description": "The identification reference of the user or customer account.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Data Source Exports and Data Query.\n\nThis field cannot be updated after the creation of the custom payment method type.\n"
},
"methodReferenceIdField": {
"type": "string",
"description": "The identification reference of the custom payment method.\n\nThis field should be mapped to a field name defined in the `fields` array for the purpose of being used as a filter in reporting tools such as Payment Method Data Source Exports and Data Query.\n\nThe value of this field must be the same as the value specified when creating the draft revision of this custom payment method type.\n\nThis field cannot be updated after the creation of the custom payment method type.\n"
}
}
}
PUTUpdateOpenPaymentMethodTypeResponse
{
"properties": {
"status": {
"type": "string",
"description": "The status of the custom payment method type.\n"
},
"revision": {
"type": "integer",
"description": "The revision number of the custom payment method type, which starts from 1 and increases by 1 when you update a published revision for the first time.\n"
},
"publishDate": {
"type": "string",
"description": "The date when the custom payment method type was published. It is emptry if the custom payment method type has not been published yet.\n"
},
"paymentMethodType": {
"type": "string",
"description": "The API name of the custom payment method type.\n"
}
}
}
PUTVerifyPaymentMethodResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The ID of the verified payment method.\n"
}
}
}
PUTVerifyPaymentMethodType
{
"type": "object",
"example": {
"securityCode": "737",
"gatewayOptions": {
"Comments": "test",
"IPAddress": "192.168.1.1"
},
"paymentGatewayName": "Adyen"
},
"properties": {
"currencyCode": {
"type": "string",
"description": "The currency used for payment method authorization. \n"
},
"securityCode": {
"type": "string",
"description": "The CVV or CVV2 security code for the credit card or debit card. To ensure PCI compliance, the value of this field is not stored and cannot be queried.\n"
},
"gatewayOptions": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The name of a gateway-specific parameter.\n"
},
"value": {
"type": "string",
"description": "The value of the gateway-specific parameter.\n"
}
},
"description": "The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).\n\nZuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.\n"
},
"paymentGatewayName": {
"type": "string",
"description": "The name of the payment gateway instance. If no value is specified for this field, the default payment gateway of the customer account will be used.\n"
}
}
}
PUTWriteOffInvoiceRequest
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoItemFromWriteOffInvoice"
},
"description": "Container for items. This field is optional. \n**Note:** If specified, you must specify ALL the items of the invoice. The entire balance of the invoice will be written off, you cannot just write off some items of the invoice.\n"
},
"comment": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "Comments about the write-off. The comment is used as the comment of the credit memo generated by writing off the specified invoice.\n"
},
"memoDate": {
"type": "string",
"format": "date",
"description": "The date when the credit memo was created, in `yyyy-mm-dd` format. The memo date must be later than or equal to the invoice date.\n\nThe default value is the date when you write off the invoice.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code `Write-off`.\n"
}
}
},
{
"$ref": "#/components/schemas/CreditMemoObjectCustomFields"
},
{
"$ref": "#/components/schemas/CreditMemoObjectNSFields"
}
],
"example": {
"memoDate": "2019-01-02"
},
"properties": {
"memoDate": {
"type": "string",
"example": "2019-01-02"
}
}
}
PUTWriteOffInvoiceResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"creditMemo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the credit memo that is created when the invoice is written off.\n"
}
},
"description": "Container for the credit memo that is automatically generated when writing off invoices.\n"
}
}
}
PatchUpdateWorkflowRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the workflow definition\n"
},
"status": {
"type": "string",
"description": "Can be `Active` or `Inactive`. Active workfow definitions run like normal. Inactive workflow definitions cannot be run.\n"
},
"description": {
"type": "string",
"description": "The description of the workflow defintion\n"
},
"active_workflow_version_id": {
"type": "integer",
"description": "The id of a version. This version will then be set to the active version of the workflow definition.\n"
}
}
}
PaymentCollectionResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"nextPage": {
"type": "string",
"format": "URL",
"description": "URL to retrieve the next page of the response if it exists; otherwise absent.\n"
},
"payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GETARPaymentTypewithSuccess"
},
"description": "Container for payments.\n"
}
}
}
PaymentData
{
"type": "object",
"properties": {
"authorizedAmount": {
"type": "number",
"format": "double",
"description": "The amount that is authorized before this API call. Only used for the Delay Capture function.\n"
},
"authTransactionId": {
"type": "string",
"description": "The authorization transaction ID from the payment gateway.\n"
},
"authorizedCurrency": {
"type": "string",
"description": "The authorization of currency code that occurs before this API call. We will verify whether it is same as the account's currency."
}
}
}
PaymentDebitMemoApplicationApplyRequestType
{
"type": "object",
"title": "debitMemos",
"required": [
"amount"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentDebitMemoApplicationItemApplyRequestType"
},
"description": "Container for debit memo items. The maximum number of items is 1,000.\n\n**Note:** This field 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_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount that is applied from the payment to the debit memo.\n"
},
"debitMemoId": {
"type": "string",
"description": "The unique ID of the debit memo that the payment is applied to.\n"
},
"debitMemoNumber": {
"type": "string",
"description": "The number of the debit memo that the payment is applied to.\n"
}
}
}
PaymentDebitMemoApplicationCreateRequestType
{
"type": "object",
"title": "debitMemos",
"required": [
"amount"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentDebitMemoApplicationItemCreateRequestType"
},
"description": "Container for debit memo items. The maximum number of items is 1,000.\n\n**Note:** This field 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_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the payment associated with the debit memo.\n"
},
"debitMemoId": {
"type": "string",
"description": "The unique ID of the debit memo that the payment is created on.\n"
}
}
}
PaymentDebitMemoApplicationItemApplyRequestType
{
"type": "object",
"title": "items",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the payment that is applied to the specific debit memo or taxation item.\n"
},
"taxItemId": {
"type": "string",
"description": "The ID of the specific taxation item.\n"
},
"debitMemoItemId": {
"type": "string",
"description": "The ID of the specific debit memo item.\n"
}
}
}
PaymentDebitMemoApplicationItemCreateRequestType
{
"type": "object",
"title": "items",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the payment associated with the specific debit memo or taxation item.\n"
},
"taxItemId": {
"type": "string",
"description": "The ID of the specific taxation item.\n"
},
"debitMemoItemId": {
"type": "string",
"description": "The ID of the specific debit memo item.\n"
}
}
}
PaymentDebitMemoApplicationItemUnapplyRequestType
{
"type": "object",
"title": "items",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the payment that is unapplied from the specific debit mem or taxation item.\n"
},
"taxItemId": {
"type": "string",
"description": "The ID of the specific taxation item.\n"
},
"debitMemoItemId": {
"type": "string",
"description": "The ID of the specific debit memo item.\n"
}
}
}
PaymentDebitMemoApplicationUnapplyRequestType
{
"type": "object",
"title": "debitMemos",
"required": [
"amount"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentDebitMemoApplicationItemUnapplyRequestType"
},
"description": "Container for debit memo items. The maximum number of items is 1,000.\n\n**Note:** This field 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_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the payment that is unapplied from the debit memo.\n"
},
"debitMemoId": {
"type": "string",
"description": "The unique ID of the debit memo that the payment is unapplied from.\n"
},
"debitMemoNumber": {
"type": "string",
"description": "The number of the debit memo that the payment is unapplied from.\n"
}
}
}
PaymentEntityPrefix
{
"type": "object",
"title": "payment",
"properties": {
"prefix": {
"type": "string",
"example": "P-",
"description": "The prefix of payments.\n"
},
"startNumber": {
"type": "integer",
"example": 10,
"description": "The starting number of payments.\n"
}
},
"description": "Container for the prefix and starting number of payments.\n"
}
PaymentInvoiceApplicationApplyRequestType
{
"type": "object",
"title": "invoices",
"required": [
"amount"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentInvoiceApplicationItemApplyRequestType"
},
"description": "Container for invoice items. The maximum number of items is 1,000.\n\n**Note:** This field 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_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount that is applied from the payment to the invoice.\n"
},
"invoiceId": {
"type": "string",
"description": "The unique ID of the invoice that the payment is applied to.\n"
},
"invoiceNumber": {
"type": "string",
"description": "The number of the invoice that the payment is applied to. For example, `INV00000001`. \n\n**Note:** When both the `invoiceNumber` and `invoiceId` fields are specified, the two fields must match with each other.\n"
}
}
}
PaymentInvoiceApplicationCreateRequestType
{
"type": "object",
"title": "invoices",
"required": [
"amount"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentInvoiceApplicationItemCreateRequestType"
},
"description": "Container for invoice items. The maximum number of items is 1,000.\n\n**Note:** This field 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_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the payment associated with the invoice. This amount must be equal to or lesser than the balance of the invoice.\n"
},
"invoiceId": {
"type": "string",
"description": "The unique ID of the invoice that the payment is created on. The balance of the invoice specified must not be `0`.\n"
}
}
}
PaymentInvoiceApplicationItemApplyRequestType
{
"type": "object",
"title": "items",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the payment that is applied to the specific invoice or taxation item.\n"
},
"taxItemId": {
"type": "string",
"description": "The ID of the specific taxation item.\n"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the specific invoice item.\n"
}
}
}
PaymentInvoiceApplicationItemCreateRequestType
{
"type": "object",
"title": "items",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the payment associated with the specific invoice or taxation item.\n"
},
"taxItemId": {
"type": "string",
"description": "The ID of the specific taxation item.\n"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the specific invoice item.\n"
}
}
}
PaymentInvoiceApplicationItemUnapplyRequestType
{
"type": "object",
"title": "items",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the payment that is unapplied from the specific invoice or taxation item.\n"
},
"taxItemId": {
"type": "string",
"description": "The ID of the specific taxation item.\n"
},
"invoiceItemId": {
"type": "string",
"description": "The ID of the specific invoice item.\n"
}
}
}
PaymentInvoiceApplicationUnapplyRequestType
{
"type": "object",
"title": "invoices",
"required": [
"amount"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentInvoiceApplicationItemUnapplyRequestType"
},
"description": "Container for invoice items. The maximum number of items is 1,000.\n\n**Note:** This field 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_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the payment that is unapplied from the invoice.\n"
},
"invoiceId": {
"type": "string",
"description": "The unique ID of the invoice that the payment is unapplied from.\n"
},
"invoiceNumber": {
"type": "string",
"description": "The number of the invoice that the payment is unapplied from. For example, `INV00000001`. \n\n**Note:** When both the `invoiceNumber` and `invoiceId` fields are specified, the two fields must match with each other.\n"
}
}
}
PaymentMethodCommonFields
{
"type": "object",
"properties": {
"type": {
"enum": [
"CreditCard",
"CreditCardReferenceTransaction",
"ACH",
"SEPA",
"Betalingsservice",
"Autogiro",
"Bacs",
"Becs",
"Becsnz",
"PAD",
"PayPalCP",
"PayPalEC",
"PayPalNativeEC",
"PayPalAdaptive",
"AdyenApplePay",
"AdyenGooglePay",
"GooglePay"
],
"type": "string",
"description": "Type of the payment method. The following types of the payment methods are supported:\n\n * `CreditCard`\n\n * `CreditCardReferenceTransaction`\n\n * `ACH`\n\n * `SEPA`\n\n * `Betalingsservice`\n\n * `Autogiro`\n\n * `Bacs`\n\n * `Becs`\n\n * `Becsnz`\n\n * `PAD`\n\n * `PayPalCP`\n\n * `PayPalEC`\n\n * `PayPalNativeEC`\n\n * `PayPalAdaptive`\n\n * `AdyenApplePay`\n\n * `AdyenGooglePay`\n\n * `GooglePay`\n\n\nTo view the schema and example applicable to a specific payment method type, select the corresponding option from the following list.\n"
},
"ipAddress": {
"type": "string",
"description": "The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. \n\nIf the IP address length is beyond 45 characters, a validation error occurs.\n\nFor validating SEPA payment methods on Stripe v2, this field is required.\n"
},
"accountKey": {
"type": "string",
"description": "Internal ID of the customer account that will own the payment method. \n\nTo create an orphan payment method that is not associated with any customer account, you do not need to specify this field during creation. However, you must associate the orphan payment method with a customer account within 10 days. Otherwise, this orphan payment method will be deleted.\n"
},
"authGateway": {
"type": "string",
"description": "Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.\n\nIf you do not set this field, Zuora will use one of the following payment gateways instead:\n\n* The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set.\n* The default payment gateway of your Zuora tenant, if the `accountKey` field is not set.\n"
},
"makeDefault": {
"type": "boolean",
"default": false,
"description": "Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set.\n\nWhen you set this field to `true`, make sure the payment method is supported by the default payment gateway.\n"
},
"currencyCode": {
"type": "string",
"example": "USD",
"description": "The currency used for payment method authorization.\n"
},
"gatewayOptions": {
"type": "object",
"example": {
"shopperEmail": "testemail@test.com",
"shopperInteraction": "POS"
},
"properties": {
"key": {
"type": "string",
"description": "The name of a gateway-specific parameter.\n"
},
"value": {
"type": "string",
"description": "The value of the gateway-specific parameter.\n"
}
},
"description": "The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).\n\nZuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.\n"
},
"skipValidation": {
"type": "boolean",
"default": false,
"description": "Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation. \n"
}
}
}
PaymentMethodObjectCustomFields
{
"type": "object",
"title": "paymentMethodFieldsCustom",
"description": "Container for custom fields of a payment method object.\n",
"additionalProperties": {
"description": "Custom fields of the payment method. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
PaymentMethodObjectCustomFieldsForAccount
{
"type": "object",
"title": "paymentMethodFieldsCustom",
"description": "Container for custom fields of a payment method object.\n",
"additionalProperties": {
"description": "Custom fields of the payment method. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
PaymentObjectCustomFields
{
"type": "object",
"title": "paymentFieldsCustom",
"description": "Container for custom fields of a Payment object.\n",
"additionalProperties": {
"description": "Custom fields of the Payment object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
PaymentObjectNSFields
{
"type": "object",
"title": "paymentFieldsNS",
"properties": {
"Origin__NS": {
"type": "string",
"maxLength": 255,
"description": "Origin of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"SyncDate__NS": {
"type": "string",
"maxLength": 255,
"description": "Date when the payment was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"Transaction__NS": {
"type": "string",
"maxLength": 255,
"description": "Related transaction in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationId__NS": {
"type": "string",
"maxLength": 255,
"description": "ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationStatus__NS": {
"type": "string",
"maxLength": 255,
"description": "Status of the payment's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
},
"description": "Container for Payment fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
PaymentRunStatistic
{
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "Payment run number.\n"
},
"status": {
"type": "string",
"description": "Payment run status.\n"
},
"executedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time the payment run is executed.\n"
},
"completedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time the payment run is completed.\n"
},
"numberOfErrors": {
"type": "integer",
"description": "Number of errored payments\n"
},
"numberOfPayments": {
"type": "integer",
"description": "Number of processed payments.\n"
}
},
"description": "Payment run statistic."
}
PaymentScheduleCommonResponse
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the payment schedule.\n"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentScheduleItemCommonResponse"
},
"description": "Container for payment schedule items.\n"
},
"period": {
"type": "string",
"description": "For recurring payment schedule only. The period of payment generation. Available values include: `Monthly`, `Weekly`, `BiWeekly`.\nReturns `null` for custom payment schedules.\n"
},
"status": {
"enum": [
"Active",
"Canceled",
"Completed"
],
"type": "string",
"description": "The status of the payment schedule.\n\n- Active: There is still payment schedule item to process.\n- Canceled: After a payment schedule is canceled by the user, the schedule is marked as `canceled`.\n- Completed: After all payment schedule items are processed, the schedule is marked as `Completed`.\n"
},
"runHour": {
"type": "integer",
"description": "[0,1,2,~,22,23]\n\nAt which hour in the day in the tenant’s timezone the recurring payment schedule items will be collected.\nReturn `0` for custom payment schedules.\n"
},
"isCustom": {
"type": "boolean",
"description": "Indicates if the payment schedule is a custom payment schedule.\n"
},
"accountId": {
"type": "string",
"description": "ID of the account that owns the payment schedule.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The date when the first payment of this payment schedule is proccessed.\n"
},
"prepayment": {
"type": "boolean",
"description": "Indicates whether the payments created by the payment schedule are used as a reserved payment. This field is available only if the prepaid cash drawdown permission is enabled. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.\n"
},
"standalone": {
"type": "boolean",
"description": "Indicates if the payments that the payment schedule created are standalone payments or not.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the user who created this payment schedule.\n"
},
"createdDate": {
"type": "string",
"format": "date",
"description": "The date and time the payment schedule is created.\n"
},
"description": {
"type": "string",
"description": "The description of the payment schedule.\n"
},
"occurrences": {
"type": "integer",
"description": "The number of payment schedule items that are created by this payment schedule.\n"
},
"totalAmount": {
"type": "number",
"description": "The total amount that will be collected by the payment schedule. \n"
},
"updatedById": {
"type": "string",
"description": "The ID of the user who last updated this payment schedule.\n"
},
"updatedDate": {
"type": "string",
"format": "date",
"description": "The date and time the payment schedule is last updated.\n"
},
"accountNumber": {
"type": "string",
"description": "Number of the account that owns the payment schedule.\n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
},
"billingDocument": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.\n"
},
"type": {
"type": "string",
"description": "Indicates whether the associated billing document is a debit memo or a invoice.\n"
},
"number": {
"type": "string",
"description": "The number of the billing docuemnt, for example, `INV00002345`.\n"
}
}
},
"nextPaymentDate": {
"type": "string",
"format": "date",
"description": "The date the next payment will be processed.\n"
},
"recentPaymentDate": {
"type": "string",
"format": "date",
"description": "The date the last payment was processed.\n"
},
"totalPaymentsErrored": {
"type": "integer",
"description": "The number of errored payments.\n"
},
"paymentScheduleNumber": {
"type": "string",
"description": "Number of the payment schedule.\n"
},
"totalPaymentsProcessed": {
"type": "integer",
"description": "The number of processed payments.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentScheduleCustomFields"
}
]
}
PaymentScheduleCustomFields
{
"type": "object",
"title": "paymentScheduleFieldsCustom",
"description": "Container for custom fields of a Payment Schedule object.\n",
"additionalProperties": {
"description": "Custom fields of the Payment Schedule object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case-sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n\n**Note:**\nThe values will automatically be pushed to payment schedule items level if the same fields exist at the payment schedule item level.\n"
}
}
PaymentScheduleItemCommon
{
"allOf": [
{
"type": "object",
"required": [
"scheduledDate",
"amount"
],
"properties": {
"amount": {
"type": "number",
"description": "The amount that needs to be collected by this payment schedule item.\n"
},
"runHour": {
"type": "string",
"description": "At which hour of the day in the tenant’s timezone this payment will be collected. Available values:`[0,1,2,~,22,23]`.\nIf the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs.\nThe default value is `0`.\n"
},
"currency": {
"type": "string",
"description": "The currency of the payment.\n\n**Note**:\n- This field is optional. If not specified, the default value is the currency set for the account.\n"
},
"description": {
"type": "string",
"description": "Description of the payment schedule item.\n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\nHere is an example:\n```\n\"paymentOption\": [\n {\n \"type\": \"GatewayOptions\",\n \"detail\": {\n \"SecCode\":\"WEB\"\n }\n }\n]\n```\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
},
"scheduledDate": {
"type": "string",
"format": "date",
"description": "The date to collect the payment.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The ID of the payment method.\n\n**Note**:\n- This field is optional. If not specified, the default value is the payment method id set for the account.\n"
},
"paymentGatewayId": {
"type": "string",
"required": [
"type"
],
"description": "The ID of the payment gateway.\n\n**Note**:\n- This field is optional. If not specified, the default value is the payment gateway id set for the account.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentScheduleItemCustomFields"
}
]
}
PaymentScheduleItemCommonResponse
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the payment schedule item. For example, `412880e749b72b310149b7343ef81346`.\n"
},
"amount": {
"type": "number",
"format": "decimal",
"description": "The total amount of the payment schedule.\n"
},
"number": {
"type": "string",
"description": "Number of the payment schedule item.\n"
},
"status": {
"enum": [
"Pending",
"Processed",
"Error",
"Canceled"
],
"type": "string",
"description": "ID of the payment method of the payment schedule item.\n\n- `Pending`: Payment schedule item is waiting for processing.\n- `Processed`: The payment has been collected.\n- `Error`: Failed to collect the payment.\n- `Canceled`: After a pending payment schedule item is canceled by the user, the item is marked as `Canceled`.\n"
},
"balance": {
"type": "number",
"format": "decimal",
"description": "The remaining balance of payment schedule item.\n"
},
"runHour": {
"type": "integer",
"description": "At which hour in the day in the tenant’s timezone this payment will be collected.\n"
},
"currency": {
"type": "string",
"description": "The currency of the payment.\n"
},
"accountId": {
"type": "string",
"description": "ID of the customer account that owns the payment schedule item, for example `402880e741112b310149b7343ef81234`.\n"
},
"paymentId": {
"type": "string",
"description": "ID of the payment that is created by the payment schedule item， or ID of the first payment linked to the payment schedule item. This field is only available if the request doesn’t specify `zuora-version`, or `zuora-version` is set to a value equal to or smaller than `336.0`. \n"
},
"standalone": {
"type": "boolean",
"description": "Indicates if the payment created by the payment schedule item is a standalone payment or not.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the user who created the payment schedule item.\n"
},
"createdDate": {
"type": "string",
"format": "date",
"description": "The date and time when the payment schedule item was created.\n"
},
"description": {
"type": "string",
"description": "The description of the payment schedule item.\n"
},
"psiPayments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LinkedPaymentID"
},
"description": "Container for payments linked to the payment schedule item. \n"
},
"updatedById": {
"type": "string",
"description": "The ID of the user who updated the payment schedule item.\n"
},
"updatedDate": {
"type": "string",
"format": "date",
"description": "The date and time when the payment schedule item was last updated.\n"
},
"errorMessage": {
"type": "string",
"description": "The error message indicating if the error is related to configuration or payment collection.\n"
},
"paymentOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSchedulePaymentOptionFields"
},
"description": "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n"
},
"scheduledDate": {
"type": "string",
"format": "date",
"description": "The scheduled date when the payment is processed.\n"
},
"billingDocument": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`.\n"
},
"type": {
"type": "string",
"description": "Indicates whether the associated billing document is a debit memo or a invoice.\n"
},
"number": {
"type": "string",
"description": "Number of the billing docuemnt, for example, `INV00002345`.\n"
}
}
},
"paymentMethodId": {
"type": "string",
"description": "ID of the payment method of the payment schedule item.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "ID of the payment gateway of the payment schedule item.\n"
},
"paymentScheduleId": {
"type": "string",
"description": "ID of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`.\n"
},
"paymentScheduleNumber": {
"type": "string",
"description": "Number of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`.\n"
}
}
},
{
"$ref": "#/components/schemas/PaymentScheduleItemCustomFields"
}
]
}
PaymentScheduleItemCustomFields
{
"type": "object",
"title": "paymentScheduleItemFieldsCustom",
"description": "Container for custom fields of a Payment Schedule Item object.\n",
"additionalProperties": {
"description": "Custom fields of the Payment Schedule Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case-sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
PaymentSchedulePaymentOptionFields
{
"type": "object",
"title": "paymentOption",
"properties": {
"type": {
"type": "string",
"description": "The type of the payment option. Currently, only `GatewayOptions` is supported for specifying Gateway Options fields supported by a payment gateway.\n"
},
"detail": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The name of the field.\n"
},
"value": {
"type": "string",
"description": "The value of the field.\n"
}
},
"description": "The field used to pass the transactional payment data to the gateway side in the key-value format.\n"
}
}
}
PaymentVolumeSummaryRecord
{
"allOf": [
{
"type": "object",
"properties": {
"error": {
"type": "integer",
"description": "The count of failed payments of above `paymentGatewayType` and `paymentMethodType`.\n"
},
"total": {
"type": "integer",
"description": "The count of total payments of above `paymentGatewayType` and `paymentMethodType`. "
},
"success": {
"type": "integer",
"description": "The count of successful payments of above `paymentGatewayType` and `paymentMethodType`.\n"
},
"paymentMethodType": {
"type": "string",
"description": "The payment method type.\n"
},
"paymentGatewayType": {
"type": "string",
"description": "The payment gateway type.\n"
}
}
}
],
"title": "volumeSummaryRecord",
"description": "A volume summary record.\n"
}
PaymentWithCustomRatesType
{
"allOf": [
{
"type": "object",
"required": [
"currency",
"customFxRate"
],
"properties": {
"currency": {
"type": "string",
"description": "The currency code for either Reporting or Home currency.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later [available versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"rateDate": {
"type": "string",
"format": "date",
"description": "The date on which a particular currency rate is fixed or obtained on.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later [available versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"customFxRate": {
"type": "number",
"format": "decimal",
"description": "The Custom FX conversion rate between Home/Reporting and Transactional currency items.\n\n**Note**: This field is only available if you set the `zuora-version` request header to `224.0` or later [available versions](https://www.zuora.com/developer/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
}
}
}
],
"title": "customRates"
}
PostAccountEInvoiceProfile
{
"allOf": [
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether to enable the e-invoicing profile for the customer account.\n\nIf the following conditions are met, all billing documents for one account can be submitted to an e-invoicing service provider to be generated in electronic format:\n- The account must be configured to generate e-invoice files for billing documents.\n- The billing document must be in Posted status.\n- A business region must be created for the billing country contact, and be linked to an e-invoicing service provider.\n"
},
"endpointId": {
"type": "string",
"description": "The Buyer's electronic address, to which the application-level response to the billing document might be delivered.\n"
},
"businessName": {
"type": "string",
"maxLength": 255,
"description": "The full official name that the Buyer is registered with the relevant legal authority.\n"
},
"businessNumber": {
"type": "string",
"description": "The unique identifier number of the legal entity or person that you do business with.\n\nFor example, you must use a GSTIN for India.\n"
},
"businessCategory": {
"enum": [
"B2B",
"B2C",
"B2G"
],
"type": "string",
"description": "The high-level category of the business.\n"
},
"endpointSchemeId": {
"type": "string",
"description": "The identification scheme identifier of the Buyer’s electronic address.\n"
},
"taxRegisterNumber": {
"type": "string",
"description": "The Buyer's VAT identifier (also known as the Buyer's VAT identification number) or the local identification (defined by the Buyer’s address) of the Buyer for tax purposes, or a reference that enables the Buyer to state the registered tax status.\n"
},
"businessNumberSchemeId": {
"type": "string",
"description": "The identification scheme identifier that an official registrar issues to identify the Buyer as a legal entity or person.\n"
}
}
}
],
"title": "einvoiceProfile",
"description": "Container for e-invoicing profile information for this account.\n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
}
PostAttachmentsRequest
{
"type": "object",
"required": [
"file"
],
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "The file to be attached. Files with the following extensions are supported: .pdf, .csv, .png, .xlsx, .xls, .doc, .docx, .msg, .jpg, .txt, .htm, .html, .eml, .pptx, .gif, .rtf, .xml, .jpeg, .log, .cls\n\nThe maximum file size is 4 MB.\n"
}
}
}
PostBatchInvoiceItemResponse
{
"allOf": [
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Indicates whether the invoice is created successfully.\n"
}
}
},
{
"$ref": "#/components/schemas/PostInvoiceResponse"
}
]
}
PostBatchInvoiceResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded.\n"
},
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostBatchInvoiceItemResponse"
}
}
}
}
PostBatchInvoicesType
{
"type": "object",
"example": {
"invoices": [
{
"autoPay": false,
"comments": "comments",
"currency": "EUR",
"accountId": "ff8080817cda56fa017cda87aaa2071e",
"invoiceDate": "2020-02-01",
"invoiceItems": [
{
"amount": 100,
"quantity": 1,
"taxItems": [
{
"name": "country tax",
"taxCode": "tax code",
"taxDate": "2020-02-01",
"taxMode": "TaxExclusive",
"taxRate": 0.01,
"taxAmount": 10,
"taxRateType": "Percentage",
"exemptAmount": 0,
"jurisdiction": "juristiction",
"locationCode": "locationCode",
"taxCodeDescription": "tax code description",
"taxRateDescription": "tax rate description"
}
],
"chargeDate": "2020-02-01 00:00:00",
"description": "description",
"discountItems": [
{
"sku": "SKU-0002",
"amount": -10,
"taxItems": [
{
"name": "country tax",
"taxCode": "country tax code",
"taxDate": "2021-02-08",
"taxMode": "TaxExclusive",
"taxRate": 0.1,
"taxAmount": -1,
"taxRateType": "Percentage",
"exemptAmount": 0,
"jurisdiction": "jurisdiction",
"locationCode": "locationCode",
"taxCodeDescription": "country tax code, tax rate 10%",
"taxRateDescription": "country tax"
}
],
"chargeDate": "2020-02-01 11:00:00",
"chargeName": "discount",
"description": "description",
"bookingReference": "discountBookingReference"
}
],
"serviceEndDate": "2020-02-10",
"bookingReference": "bookingReference",
"serviceStartDate": "2020-02-01",
"purchaseOrderNumber": "PO-000303",
"productRatePlanChargeId": "ff8080817cda56fa017cda87999d071b"
},
{
"sku": "sku-001",
"uom": "each",
"amount": 100,
"quantity": 1,
"chargeDate": "2020-02-01 00:00:00",
"chargeName": "charge name",
"description": "description",
"serviceEndDate": "2020-02-10",
"bookingReference": "bookingReference",
"serviceStartDate": "2020-02-01",
"purchaseOrderNumber": "PO-000303"
}
]
},
{
"autoPay": false,
"comments": "comments",
"currency": "EUR",
"accountId": "ff8080817cda56fa017cda87aaa2071e",
"invoiceDate": "2020-02-01",
"invoiceItems": [
{
"amount": 100,
"quantity": 1,
"taxItems": [
{
"name": "country tax",
"taxCode": "tax code",
"taxDate": "2020-02-01",
"taxMode": "TaxExclusive",
"taxRate": 0.01,
"taxAmount": 10,
"taxRateType": "Percentage",
"exemptAmount": 0,
"jurisdiction": "juristiction",
"locationCode": "locationCode",
"taxCodeDescription": "tax code description",
"taxRateDescription": "tax rate description"
}
],
"chargeDate": "2020-02-01 00:00:00",
"description": "description",
"serviceEndDate": "2020-02-10",
"bookingReference": "bookingReference",
"serviceStartDate": "2020-02-01",
"purchaseOrderNumber": "PO-000303",
"productRatePlanChargeId": "ff8080817cda56fa017cda87999d071b"
},
{
"sku": "sku-001",
"uom": "each",
"amount": 100,
"quantity": 1,
"chargeDate": "2020-02-01 00:00:00",
"chargeName": "charge name",
"description": "description",
"serviceEndDate": "2020-02-10",
"bookingReference": "bookingReference",
"serviceStartDate": "2020-02-01",
"purchaseOrderNumber": "PO-000303"
}
]
}
],
"useSingleTransaction": false
},
"properties": {
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostInvoiceType"
},
"description": "Container for standalone invoices.\n"
},
"useSingleTransaction": {
"type": "boolean",
"description": "Whether a batch request is handled with a single transaction.\n\n- `true` indicates that a batch request will be handled with a single transaction.\n- `false` indicates that the standalone invoices to be created in a batch request will be handled with separated transactions.\n\nIf the field is set to `false`, a failure in the batch request will not cause the whole request to fail, so you have to retry the whole batch request.\n"
}
}
}
PostBillingPreviewParam
{
"type": "object",
"example": {
"targetDate": "2017-05-10",
"accountNumber": "A00000001",
"assumeRenewal": "None",
"chargeTypeToExclude": "",
"includingEvergreenSubscription": "true"
},
"required": [
"targetDate"
],
"properties": {
"accountId": {
"type": "string",
"maxLength": 255,
"description": "The ID of the customer account to which the billing preview applies.\n\n**Note**: When posting billing preview, you must specify either `accountId` or `accountNumber` in the request body.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for the billingPreview call. The billingPreview call generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the TargetDate. \n\nIf the TargetDate is later than the subscription current term end date, the preview invoice item data and credit memo item data is generated from the first day of the customer's next billing period to the current term end date. If you want to generate preview invoice item data and credit memo item data past the end of the subscription current term, specify the `AssumeRenewal` field in the request.\n\n\n**Note:** The credit memo item data is only available if you have Invoice Settlement feature 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"accountNumber": {
"type": "string",
"description": "The number of the customer account to which the billing preview applies.\n\n**Note**: When posting billing preview, you must specify either `accountId` or `accountNumber` in the request body.\n"
},
"assumeRenewal": {
"type": "string",
"description": "Indicates whether to generate a preview of future invoice items and credit memo items with the assumption that the subscriptions are renewed.\n\nSet one of the following values in this field to decide how the assumption is applied in the billing preview.\n\n * **All:** The assumption is applied to all the subscriptions. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date.\n \n * **None:** (Default) The assumption is not applied to the subscriptions. Zuora generates preview invoice item data and credit memo item data based on the current term end date and the target date.\n \n * If the target date is later than the current term end date, Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the current term end date.\n\n * If the target date is earlier than the current term end date, Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date.\n\n * **Autorenew:** The assumption is applied to the subscriptions that have auto-renew enabled. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date.\n\n**Note:** \n - This field can only be used if the subscription renewal term is not set to 0. \n \n \n - The credit memo item data is only available if you have Invoice Settlement feature 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"chargeTypeToExclude": {
"type": "string",
"description": "The charge types to exclude from the billing preview.\n\n**Possible values:** OneTime, Recurring, Usage, and any combination of these values.\n"
},
"includingDraftItems": {
"type": "boolean",
"description": "Whether draft document items are included in the billing preview run. By default, draft document items are not included.\n\nThis field loads draft invoice items and credit memo items. The `chargeTypeToExclude`, `targetDate`, `includingEvergreenSubscription`, and `assumeRenewal` fields do not affect the behavior of the `includingDraftItems` field. \n"
},
"includingEvergreenSubscription": {
"type": "boolean",
"description": "Indicates if evergreen subscriptions are included in the billingPreview call.\n"
}
}
}
PostBillingPreviewRunParam
{
"type": "object",
"example": {
"batches": "Batch1, Batch2",
"targetDate": "2017-01-10",
"assumeRenewal": "None",
"storageOption": "Database",
"storeDifference": "true",
"chargeTypeToExclude": "",
"includingDraftItems": "false",
"comparedBillingPreviewRunId": "woeijfowejfow",
"includingEvergreenSubscription": "true"
},
"required": [
"targetDate"
],
"properties": {
"batch": {
"type": "string",
"maxLength": 255,
"description": "The customer batch to include in the billing preview run. If not specified, all customer batches are included. \n\n**Note**: \n - **Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite\" target=\"_blank\">Performance Booster Elite</a> package.\n - This field is not available if you set the `zuora-version` request header to `314.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"batches": {
"type": "string",
"maxLength": 1000,
"description": "The customer batches to include in the billing preview run. You can specify multiple batches separated by comma. If not specified, all customer batches are included.\n\n**Note**: \n - By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite\" target=\"_blank\">Performance Booster Elite</a> package.\n - This field is only available if you set the `zuora-version` request header to `314.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for the billing preview run. The billing preview run generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date. \n\nThe value for the `targetDate` field must be in _`YYYY-MM-DD`_ format.\n\nIf the target date is later than the subscription current term end date, the preview invoice item data and credit memo item data is generated from the first day of the customer's next billing period to the current term end date. If you want to generate preview invoice item data and credit memo item data past the end of the subscription current term, specify the AssumeRenewal field in the request.\n\n**Note:** The credit memo item data is only available if you have Invoice Settlement feature 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"assumeRenewal": {
"type": "string",
"description": "Indicates whether to generate a preview of future invoice items and credit memo items with the assumption that the subscriptions are renewed.\n\nSet one of the following values in this field to decide how the assumption is applied in the billing preview.\n\n * **All:** The assumption is applied to all the subscriptions. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date.\n \n * **None:** (Default) The assumption is not applied to the subscriptions. Zuora generates preview invoice item data and credit memo item data based on the current term end date and the target date.\n \n * If the target date is later than the current term end date, Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the current term end date.\n\n * If the target date is earlier than the current term end date, Zuora generates preview invoice item data and credit memeo item data from the first day of the customer's next billing period to the target date.\n\n * **Autorenew:** The assumption is applied to the subscriptions that have auto-renew enabled. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date.\n\n \n**Note:** \n - This field can only be used if the subscription renewal term is not set to 0. \n \n \n - The credit memo item data is only available if you have Invoice Settlement feature 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n"
},
"storageOption": {
"enum": [
"Csv",
"Database"
],
"type": "string",
"description": "The saving options. The default value is `Csv`.\n\nTo compare the current billing preview run result with a specified billing preview run result and store the difference in the database, you must set the `storageOption` field to `Database`. **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>.\n"
},
"storeDifference": {
"type": "boolean",
"description": "Specify this field to `yes` to compare the current billing preview run result with a specified billing preview run result and store the difference in the database. You can view the difference in the Billing Preview Run Result Difference data source. **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>.\n\nThe default value is `false`.\n"
},
"organizationLabels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "The organization ID.\n"
},
"organizationName": {
"type": "string",
"description": "The organization name.\n"
}
}
},
"description": "The organization(s) that this billing preview run is created for. \n\nFor each item in the array, either the `organizationId` or the `organizationName` field is required.\n\nThis field is only required when you have already turned on Multi-Org feature.\n"
},
"chargeTypeToExclude": {
"type": "string",
"description": "The charge types to exclude from the forecast run.\n\n**Possible values:** OneTime, Recurring, Usage, and any comma-separated combination of these values.\n"
},
"includingDraftItems": {
"type": "boolean",
"description": "Whether draft document items are included in the billing preview run. By default, draft document items are not included.\n\nThis field loads draft invoice items and credit memo items. The `chargeTypeToExclude`, `targetDate`, `includingEvergreenSubscription`, and `assumeRenewal` fields do not affect the behavior of the `includingDraftItems` field.\n"
},
"comparedBillingPreviewRunId": {
"type": "string",
"description": "Specify an existing billing preview run result to compare the current billing preview result with. You can view the difference in the Billing Preview Run Result Difference data source. **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>.\n"
},
"includingEvergreenSubscription": {
"type": "boolean",
"description": "Whether evergreen subscriptions are included in the billing preview run. By default, evergreen subscriptions are not included.\n"
}
}
}
PostBillingPreviewRunResponse
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"billingPreviewRunId": {
"type": "string",
"description": "Id of the billing preview run.\n"
}
}
}
PostCompareTemplateRequest
{
"type": "object",
"properties": {
"template": {
"type": "string",
"format": "binary",
"description": "Template contains the config metadata and target tenant information."
}
}
}
PostCreateBookingDateBackfillJobResponse
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"description": "String of 32 characters that identifies the booking date backfill job. \nThe id is generated before the backfill job is processed. \nYou can use the id to get the booking date backfill job result.\n"
}
}
}
]
}
PostCreateDataBackfillJobRequest
{
"type": "object",
"required": [
"file",
"type"
],
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "A file containing the data about the fields that you want to backfill. This file must be a `.csv` file or a zipped `.csv` file. The maximum file size is 4 MB. The data in the file must be formatted according to the data backfill action type that you want to perform.\n\nYou can download a file template to view all fields supported for your data backfill. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Perform_data_backfill#Perform_data_backfill\" target=\"_blank\">Perform data backfill</a>.\n"
},
"type": {
"$ref": "#/components/schemas/DataBackfillJob"
},
"checksum": {
"type": "string",
"maxLength": 32,
"minLength": 32,
"description": "An MD5 checksum that is used to validate the integrity of the uploaded file."
}
}
}
PostCreateDataBackfillJobResponse
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"description": "String of 32 characters that identifies the data backfill job. The id is generated before the job is processed. You can use the id to retrieve the data backfill job result.\n"
}
}
}
]
}
PostCreateDraftOpenPaymentMethodTypeResponse
{
"type": "object",
"example": {
"status": "Draft",
"revision": 1,
"publishDate": "",
"paymentMethodType": "AmazonPay__C_12368"
},
"properties": {
"status": {
"type": "string",
"example": "Draft"
},
"revision": {
"type": "number",
"example": 1
},
"publishDate": {
"type": "string",
"example": ""
},
"paymentMethodType": {
"type": "string",
"example": "AmazonPay__C_12368"
}
}
}
PostCreateInvoiceContactType
{
"allOf": [
{
"type": "object",
"required": [
"firstName",
"lastName"
],
"properties": {
"fax": {
"type": "string",
"maxLength": 40,
"description": "Fax phone number, 40 characters or less.\n"
},
"city": {
"type": "string",
"maxLength": 40,
"description": "City, 40 characters or less.\n"
},
"state": {
"type": "string",
"description": "State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided.\n"
},
"county": {
"type": "string",
"maxLength": 32,
"description": "County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax.\n"
},
"country": {
"type": "string",
"description": "Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.\n"
},
"zipCode": {
"type": "string",
"maxLength": 20,
"description": "Zip code, 20 characters or less.\n"
},
"address1": {
"type": "string",
"maxLength": 255,
"description": "First address line, 255 characters or less.\n"
},
"address2": {
"type": "string",
"description": "Second address line, 255 characters or less.\n"
},
"lastName": {
"type": "string",
"maxLength": 100,
"description": "Last name, 100 characters or less.\n"
},
"nickname": {
"type": "string",
"description": "Nickname for this contact\n"
},
"firstName": {
"type": "string",
"maxLength": 100,
"description": "First name, 100 characters or less.\n"
},
"homePhone": {
"type": "string",
"maxLength": 40,
"description": "Home phone number, 40 characters or less.\n"
},
"taxRegion": {
"type": "string",
"description": "If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.\n"
},
"workEmail": {
"type": "string",
"maxLength": 80,
"description": "Work email address, 80 characters or less.\n"
},
"workPhone": {
"type": "string",
"maxLength": 40,
"description": "Work phone number, 40 characters or less.\n"
},
"otherPhone": {
"type": "string",
"maxLength": 40,
"description": "Other phone number, 40 characters or less.\n"
},
"mobilePhone": {
"type": "string",
"maxLength": 40,
"description": "Mobile phone number, 40 characters or less.\n"
},
"personalEmail": {
"type": "string",
"maxLength": 80,
"description": "Personal email address, 80 characters or less.\n"
},
"otherPhoneType": {
"type": "string",
"description": "Possible values are: `Work`, `Mobile`, `Home`, `Other`.\n"
}
}
},
{
"$ref": "#/components/schemas/ContactCustomFields"
}
],
"title": "Contact",
"description": "Container for bill-to or sold-to contact information. A new Contact will be created under the invoice owner account.\n \n**Note**: If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.\n"
}
PostCreateOrderAsynchronouslyResponse
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"format": "UUID",
"description": "The ID of an asynchronous job that will be returned for tracking the status and result of the job."
},
"success": {
"type": "boolean",
"description": "Indicates whether the operation call succeeded."
}
}
}
PostCreditMemoEmailRequestType
{
"type": "object",
"example": {
"pdfFileId": "162297b6f8d94edc81373f6037af76fa",
"emailAddresses": "contact1@example.com,contact2@example.com",
"useEmailTemplateSetting": false,
"includeAdditionalEmailAddresses": false
},
"properties": {
"pdfFileId": {
"type": "string",
"description": "The ID of the PDF file that you want to send in the email. \n\nIf you do not specify any PDF file ID, the latest PDF file generated for the credit memo is sent in the email.\n"
},
"emailAddresses": {
"type": "string",
"description": "The valid email addresses you want to email a credit memo to. Use commas to separate email addresses.\n\n**Note:** This field is only applicable if you set the `useEmailTemplateSetting` field to `false`.\n"
},
"useEmailTemplateSetting": {
"enum": [
true,
false
],
"type": "boolean",
"default": false,
"description": "Indicates whether to email a credit memo based on the email template setting. \n\nIf you set this field to `true`, the credit memo is sent to the email addresses specified in the **To Email** field of the email template. The email template is the one you set in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. See [Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information about how to edit the **To Email** field in the email template.\n"
},
"includeAdditionalEmailAddresses": {
"enum": [
true,
false
],
"type": "boolean",
"default": false,
"description": "Indicates whether to send a credit memo to the additional email addresses of the memo account. \n\n\nYou can set the additional email addresses in the **Additional Email Addresses** field on the account detail page from the Zuora UI. See [Create a Customer Account](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/B_Create_a_Customer_Account#section_2) for more information.\n"
}
}
}
PostCustomObjectDefinitionFieldDefinitionRequest
{
"type": "object",
"title": "customObjectCustomFieldDefinition",
"required": [
"type",
"label"
],
"properties": {
"type": {
"type": "string",
"description": "The data type of the custom field"
},
"label": {
"type": "string",
"description": "The UI label of the custom field"
},
"format": {
"type": "string",
"description": "The data format of the custom field"
},
"maxLength": {
"type": "integer",
"description": "The maximum length of string that can be stored in the custom field.\n\nThis field applies only to the following custom field types:\n\n- Text:\n - The `type` field is `string`.\n - The `format` field is not specified or is `url`.\n - The `enum` field is not specified.\n- Picklist:\n - The `type` field is `string`.\n - The `enum` field is specified.\n - The `multiselect` field is not specified or is `false`.\n- Multiselect:\n - The `type` field is `string`.\n - The `enum` field is specified.\n - The `multiselect` field is `true`.\n\nIf the custom field is filterable, the value of `maxLength` must be 512 or less.\n"
},
"displayName": {
"type": "boolean",
"description": "Indicates whether to use this field as the display name of the custom object when being linked to another custom object.\n\nThis field applies only to the Text custom field type:\n\n- The `type` field is `string`.\n- The `enum` field is not specified.\n"
},
"multiselect": {
"type": "boolean",
"description": "Indicates whether this is a multiselect custom field.\n\nThis field applies only to the Picklist or Multiselect custom field types:\n\n- The `type` field is `string`.\n- The `maxLength` field is specified.\n- The `enum` field is specified.\n"
}
}
}
PostCustomObjectDefinitionFieldsDefinitionRequest
{
"type": "object",
"title": "customObjectCustomFieldDefinitions",
"additionalProperties": {
"$ref": "#/components/schemas/PostCustomObjectDefinitionFieldDefinitionRequest"
}
}
PostCustomObjectDefinitionsRequest
{
"type": "object",
"example": {
"definitions": {
"Delivery": {
"label": "Delivery",
"object": "Delivery",
"required": [
"SubscriptionId__c",
"ContactId__c",
"ProductName__c",
"Quantity__c",
"ShippingDate__c"
],
"filterable": [
"Quantity__c",
"ProductName__c",
"Cancelled__c",
"ShippingStatus__c"
],
"properties": {
"Quantity__c": {
"type": "integer",
"label": "Quantity",
"maximum": 20,
"minimum": 1,
"description": "The quantity of product that is being shipped to customer."
},
"Cancelled__c": {
"type": "boolean",
"label": "Shipment Cancelled",
"default": false,
"description": "Indicator is true when the customer has cancelled this particular shipment."
},
"ContactId__c": {
"type": "string",
"label": "Ship To Customer",
"format": "uuid",
"description": "The customer contact who will receive the shipment."
},
"ProductName__c": {
"type": "string",
"label": "Product Name",
"description": "The name of the product that is being shipped to customer."
},
"TotalWeight__c": {
"type": "number",
"label": "Total Weight (lbs.)",
"minimum": 0,
"description": "The total weight of the product and packaging that is being shipped to customer."
},
"ContactEmail__c": {
"type": "string",
"label": "Customer Email",
"maxLength": 128,
"description": "The customer's email address."
},
"ShippingDate__c": {
"type": "string",
"label": "Shipping Date",
"format": "date",
"description": "The date the product will be sent to shipping vendor for delivery."
},
"ShippingStatus__c": {
"enum": [
"Pending",
"Preparing shipment",
"Waiting for tracking information",
"Shipped"
],
"type": "string",
"label": "Shipping Status",
"default": "Pending",
"description": "The status of the shipment - e.g. Pending, Preparing shipment, Waiting for tracking information, or Shipped."
},
"SubscriptionId__c": {
"type": "string",
"label": "Subscription",
"format": "uuid",
"description": "The subscription that is associated with the shipment record."
},
"CancellationTime__c": {
"type": "string",
"label": "Cancellation Time",
"format": "date-time",
"description": "The time at which customer cancelled this particular shipment."
}
},
"description": "Delivery schedule for shipping products based on customer's subscription.",
"relationships": [
{
"fields": {
"SubscriptionId__c": "Id"
},
"object": "subscription",
"namespace": "com_zuora",
"cardinality": "manyToOne",
"recordConstraints": {
"create": {
"enforceValidMapping": false
}
}
},
{
"fields": {
"ContactId__c": "Id"
},
"object": "contact",
"namespace": "com_zuora",
"cardinality": "manyToOne",
"recordConstraints": {
"create": {
"enforceValidMapping": false
}
}
}
]
},
"birth_place_custom_object": {
"type": "object",
"label": "Birth Place Custom Object",
"object": "birth_place_custom_object",
"required": [
"city__c",
"state__c",
"country__c"
],
"filterable": [
"city__c"
],
"properties": {
"city__c": {
"type": "string",
"label": "city label"
},
"state__c": {
"type": "string",
"label": "state label"
},
"country__c": {
"type": "string",
"label": "country label"
},
"ContactId__c": {
"type": "string",
"label": "Contact",
"format": "uuid"
}
},
"relationships": [
{
"fields": {
"ContactId__c": "Id"
},
"object": "contact",
"namespace": "com_zuora",
"cardinality": "manyToOne",
"recordConstraints": {
"create": {
"enforceValidMapping": false
}
}
}
]
}
}
},
"properties": {
"definitions": {
"$ref": "#/components/schemas/PostCustomObjectDefinitionsRequestDefinitions"
}
}
}
PostCustomObjectDefinitionsRequestDefinition
{
"type": "object",
"title": "customObjectDefinition",
"required": [
"object",
"label"
],
"properties": {
"label": {
"type": "string",
"description": "A UI label for the custom object"
},
"object": {
"type": "string",
"description": "The API name of the custom object"
},
"unique": {
"type": "array",
"items": {
"type": "string"
},
"description": "The fields with unique constraints. You can remove the unique constraint on a field. However, you can only add a unique constraint to a filterable field if the custom object contains no record. One custom object can have a maximum of five fields with unique constraints."
},
"required": {
"type": "array",
"items": {
"type": "string"
},
"description": "The required fields of the custom object. You can change required fields to optional. However, you can only change optional fields to required on the custom objects with no records."
},
"auditable": {
"type": "array",
"items": {
"type": "string"
},
"description": "The set of fields which Audit Trail tracks and records changes of. You can change auditable fields to non-auditable, and vice versa. One custom object can have a maximum of five auditable fields."
},
"filterable": {
"type": "array",
"items": {
"type": "string"
},
"description": "The set of fields that are allowed to be queried on. Queries on non-filterable fields will be rejected. You can not change a non-filterable field to filterable."
},
"properties": {
"$ref": "#/components/schemas/PostCustomObjectDefinitionFieldsDefinitionRequest"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"required": [
"namespace",
"object",
"fields"
],
"properties": {
"fields": {
"$ref": "#/components/schemas/FieldsAdditionalPropertiesForPostDefinition"
},
"object": {
"type": "string",
"description": "The API name of the related object"
},
"namespace": {
"type": "string",
"description": "The namespace where the related object is located"
},
"cardinality": {
"enum": [
"manyToOne"
],
"type": "string",
"description": "The cardinality of the relationship from this object to another object.\n\nOnly the `manyToOne` cardinality can be used when creating relationships. A relationship with `oneToMany` cardinality is created implicitly when a `manyToOne` relationship is created.\n\nA custom object definition can have a maximum of 2 `manyToOne` relationships.\n"
},
"recordConstraints": {
"type": "object",
"properties": {
"create": {
"type": "object",
"properties": {
"enforceValidMapping": {
"type": "boolean",
"default": true,
"description": "Specifies whether Zuora validates the values of mapped fields\nin custom object records.\n\nBy default, Zuora validates the values of mapped fields\nin custom object records. For example, if the\ncustom object definition has a field called `AccountId__c`\nthat is mapped to the `Id` field of the `account` object,\nZuora verifies that the value of `AccountId__c` is a valid\naccount ID when a custom object record is created.\nIf the value of `AccountId__c` is not a valid account ID,\nthe operation fails.\n"
}
}
}
},
"description": "Specifies contraints to apply to custom object records.\n"
}
}
},
"description": "An array of relationships with Zuora objects or other custom objects. You can add at most 2 `manyToOne` relationships when creating a custom field definition."
},
"enableCreateRecordAuditing": {
"type": "boolean",
"default": false,
"description": "Indicates whether to audit the creation of custom object records of this custom object definition.\n\nNote that you must enable the **Custom Object Definition** audit trail setting in your Zuora tenant before auditing custom object record creation. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/Manage_Audit_Trail_Settings\" target=\"_blank\">Manage audit trail settings</a>.\n"
},
"enableDeleteRecordAuditing": {
"type": "boolean",
"default": false,
"description": "Indicates whether to audit the deletion of custom object records of this custom object definition.\n\nNote that you must enable the **Custom Object Definition** audit trail setting in your Zuora tenant before auditing custom object record deletion. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/Manage_Audit_Trail_Settings\" target=\"_blank\">Manage audit trail settings</a>.\n"
}
}
}
PostCustomObjectDefinitionsRequestDefinitions
{
"type": "object",
"title": "customObjectDefinitions",
"description": "The custom object definitions. This object maps types to custom object definitions.\n",
"additionalProperties": {
"$ref": "#/components/schemas/PostCustomObjectDefinitionsRequestDefinition"
}
}
PostCustomObjectRecordsRequest
{
"type": "object",
"example": {
"records": [
{
"OrderId__c": "c086028c-5df8-427d-a3c8-7a7fb5d32d3d",
"ItemName__c": "test",
"ItemType__c": "Product",
"ItemState__c": "PendingCreation",
"ItemNumber__c": "1",
"GrossAmount__c": 123
},
{
"OrderId__c": "c086028c-5df8-427d-a3c8-7a7fb5d32d3d",
"ItemName__c": "test",
"ItemType__c": "Product",
"ItemState__c": "PendingCreation",
"ItemNumber__c": "1",
"GrossAmount__c": "123"
}
],
"allowPartialSuccess": true
},
"required": [
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomObjectRecordWithOnlyCustomFields"
},
"description": "A list of custom object records to be created"
},
"allowPartialSuccess": {
"type": "boolean",
"default": false,
"example": true,
"description": "Indicates whether the records that pass the schema validation should be created when not all records in the request pass the schema validation."
}
}
}
PostCustomObjectRecordsResponse
{
"type": "object",
"example": {
"error": {
"code": 71012520,
"details": [
{
"code": 71012524,
"record": {
"Id": "ca0b22f3-7bea-4a19-b4fc-7712c24c6516",
"OrderId__c": "c086028c-5df8-427d-a3c8-7a7fb5d32d3d",
"ItemName__c": "test",
"ItemType__c": "Product",
"ItemState__c": "PendingCreation",
"ItemNumber__c": "1",
"GrossAmount__c": "123"
},
"message": "Json input does not match schema. Error: Field [GrossAmount] should be number type but received string."
}
],
"message": "Request contains invalid record that failed validation against the object schema."
},
"records": [
{
"Id": "46b79af2-9892-4937-80a0-6f5841a85f19",
"type": "OrderLineItem",
"OrderId__c": "c086028c-5df8-427d-a3c8-7a7fb5d32d3d",
"CreatedById": "11e65ead-0ead-4025-bd2d-002590fc20f6",
"CreatedDate": "2021-05-11T17:55:17.854Z",
"ItemName__c": "test",
"ItemType__c": "Product",
"UpdatedById": "11e65ead-0ead-4025-bd2d-002590fc20f6",
"UpdatedDate": "2021-05-11T17:55:17.854Z",
"ItemState__c": "PendingCreation",
"ItemNumber__c": "1",
"GrossAmount__c": 123
}
]
},
"properties": {
"error": {
"$ref": "#/components/schemas/CustomObjectRecordsErrorResponse"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomObjectRecordWithAllFields"
},
"description": "The custom object records that are succesfully created and stored"
}
}
}
PostDebitMemoEmailType
{
"type": "object",
"example": {
"pdfFileId": "162297b6f8d94edc81373f6037af76fa",
"emailAddresses": "contact1@example.com,contact2@example.com",
"useEmailTemplateSetting": false,
"includeAdditionalEmailAddresses": false
},
"properties": {
"pdfFileId": {
"type": "string",
"description": "The ID of the PDF file that you want to send in the email. \n\nIf you do not specify any PDF file ID, the latest PDF file generated for the debit memo is sent in the email.\n"
},
"emailAddresses": {
"type": "string",
"description": "The valid email addresses you want to email a debit memo to. Use commas to separate email addresses.\n\n**Note:** This field is only applicable if you set the `useEmailTemplateSetting` field to `false`.\n"
},
"useEmailTemplateSetting": {
"enum": [
true,
false
],
"type": "boolean",
"default": false,
"description": "Indicates whether to email a debit memo based on the email template setting. \n\nIf you set this field to `true`, the debit memo is sent to the email addresses specified in the **To Email** field of the email template. The email template is the one you set in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. See [Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information about how to edit the **To Email** field in the email template.\n"
},
"includeAdditionalEmailAddresses": {
"enum": [
true,
false
],
"type": "boolean",
"default": false,
"description": "Indicates whether to send a debit memo to the additional email addresses of the memo account. \n\n\nYou can set the additional email addresses in the **Additional Email Addresses** field on the account detail page from the Zuora UI. See [Create a Customer Account](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/B_Create_a_Customer_Account#section_2) for more information.\n"
}
}
}
PostDiscountItemType
{
"allOf": [
{
"type": "object",
"title": "invoiceItems",
"required": [
"amount"
],
"properties": {
"sku": {
"type": "string",
"description": "The SKU of the invoice item. The SKU of the discount item must be different from the SKU of any existing product.\n"
},
"amount": {
"type": "string",
"format": "number",
"description": "The amount of the discount item.\n- Should be a negative number. For example, `-10`.\n- Always a fixed amount no matter whether the discount charge associated with the discount item uses the [fixed-amount model or percentage model](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models#Fixed_amount_model_and_percentage_model).\n- For tax-exclusive discount items, this amount indicates the discount item amount excluding tax.\n- For tax-inclusive discount items, this amount indicates the discount item amount including tax.\n"
},
"itemType": {
"type": "string",
"description": "The type of the discount item.\n"
},
"taxItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostTaxationItemType"
},
"description": "Container for taxation items. The maximum number of taxation items is 5.\n\n**Note**: This field is only available only if you have Taxation enabled.\n"
},
"unitPrice": {
"type": "string",
"format": "number",
"description": "The per-unit price of the discount item.\nIf the discount charge associated with the discount item uses the percentage model, the unit price will display as a percentage amount in PDF. For example: if unit price is 5.00, it will display as 5.00% in PDF.\n"
},
"chargeDate": {
"type": "string",
"format": "date-time",
"description": "The date when the discount item is charged, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"chargeName": {
"type": "string",
"description": "The name of the charge associated with the discount item.\nThis field is required if the `productRatePlanChargeId` field is not specified in the request body.\n"
},
"revRecCode": {
"type": "string",
"description": "The revenue recognition code.\n"
},
"description": {
"type": "string",
"description": "The description of the discount item.\n"
},
"accountingCode": {
"type": "string",
"description": "The accounting code associated with the discount item.\n"
},
"bookingReference": {
"type": "string",
"description": "The booking reference of the discount item.\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "The purchase order number associated with the discount item.\n"
},
"revRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate"
],
"type": "string",
"description": "The date when revenue recognition is triggered.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of the product rate plan charge that the discount item is created from.\n\nIf you specify a value for the `productRatePlanChargeId` field in the request, Zuora directly copies the values of the following fields from the corresponding product rate plan charge, regardless of the values specified in the request body:\n- `chargeName`\n- `sku`\n\nIf you specify a value for the `productRatePlanChargeId` field in the request, Zuora directly copies the values of the following fields from the corresponding discount charge that [uses discount specific accounting codes, rule and segment to manage revenue](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/Manage_Discount_Charges#Use_discount_specific_accounting_codes.2C_rule_and_segment_to_manage_revenue), regardless of the values specified in the request body:\n- `accountingCode`\n- `deferredRevenueAccountingCode`\n- `recognizedRevenueAccountingCode`\n\nIf you specify a value for the `productRatePlanChargeId` field in the request, Zuora directly copies the values of the following fields from the corresponding invoice item charge if the discount charge DOES NOT [use discount specific accounting codes, rule and segment to manage revenue](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/Manage_Discount_Charges#Use_discount_specific_accounting_codes.2C_rule_and_segment_to_manage_revenue), regardless of the values specified in the request body:\n- `accountingCode`\n- `deferredRevenueAccountingCode`\n- `recognizedRevenueAccountingCode`\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"contractAssetAccountingCode": {
"type": "string",
"description": "The accounting code for contract asset.\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment revenue.\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.\n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for contract liability.\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"accountsReceivableAccountingCode": {
"type": "string",
"description": "The accounting code for accounts receivable.\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment liability.\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.\n"
},
"unbilledReceivablesAccountingCode": {
"type": "string",
"description": "The accounting code for unbilled receivables.\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.\n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for contract recognized revenue.\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.\n"
}
}
},
{
"$ref": "#/components/schemas/DiscountItemObjectNSFields"
},
{
"$ref": "#/components/schemas/DiscountItemObjectCustomFields"
}
]
}
PostEventTriggerRequest
{
"type": "object",
"example": {
"active": true,
"condition": "changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000",
"eventType": {
"name": "LargeInvoicePosted",
"description": "An invoice is posted with amount over 1000",
"displayName": "Large Invoice Posted"
},
"baseObject": "Invoice",
"description": "Trigger an event when an invoice is posted with amount over 1000"
},
"required": [
"baseObject",
"condition",
"eventType",
"active"
],
"properties": {
"active": {
"type": "boolean",
"description": "The status of the event trigger."
},
"condition": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "The JEXL expression to be evaluated against object changes. See above for more information and an example."
},
"eventType": {
"$ref": "#/components/schemas/EventType"
},
"baseObject": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "The base object that the trigger rule 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__<custom_object_api_name>`. For example, `default__vehicle`.\n"
},
"description": {
"type": "string",
"maxLength": 1000,
"description": "The description of the event trigger."
}
}
}
PostFulfillmentItemsRequestType
{
"type": "object",
"example": {
"fulfillmentItems": [
{
"description": "description1",
"customFields": {
"PICKLIST_CF__c": "option_1"
},
"itemIdentifier": "0c27b769-5bba-46a5-80aa-cdd95f931216",
"fulfillmentNumber": "F-00000001"
},
{
"description": "description2",
"customFields": {
"PICKLIST_CF__c": "option_2"
},
"itemIdentifier": "456d3812-33d2-454c-b272-4c5a9a3e2742",
"fulfillmentNumber": "F-00000001"
}
]
},
"properties": {
"fulfillmentItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FulfillmentItemPost"
}
}
}
}
PostFulfillmentItemsResponseType
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"fulfillmentItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "UUID",
"description": "The sytem generated Id.\n"
}
}
}
}
}
}
]
}
PostFulfillmentsRequestType
{
"type": "object",
"example": {
"fulfillments": [
{
"state": "SentToBilling",
"quantity": 5,
"billTargetDate": "2022-01-01",
"fulfillmentDate": "2022-01-01",
"fulfillmentType": "Delivery",
"orderLineItemId": "4028828c82819b740182821bb23e15c4"
},
{
"state": "SentToBilling",
"quantity": 5,
"billTargetDate": "2022-01-01",
"fulfillmentDate": "2022-01-01",
"fulfillmentType": "Delivery",
"orderLineItemId": "4028828c82819b740182821bb23e15c4"
}
],
"processingOptions": {
"runBilling": true,
"billingOptions": {
"targetDate": "2022-01-01",
"documentDate": "2022-01-01"
},
"collectPayment": true
}
},
"properties": {
"fulfillments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FulfillmentPost"
}
},
"processingOptions": {
"$ref": "#/components/schemas/ProcessingOptions"
}
}
}
PostFulfillmentsResponseType
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"paidAmount": {
"type": "number",
"description": "The total amount collected in this request.\n"
},
"fulfillments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "UUID",
"description": "The sytem generated Id.\n"
},
"fulfillmentItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "UUID",
"description": "The sytem generated Id.\n"
}
}
}
},
"fulfillmentNumber": {
"type": "string",
"description": "The sytem generated number for the Fulfillment.\n"
}
}
}
},
"paymentNumber": {
"type": "string",
"description": "The payment number collected in this request.\n"
},
"invoiceNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the invoice numbers generated in this request. Normally it includes one invoice number only.\n"
},
"creditMemoNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the credit memo numbers generated in this request. The credit memo is only available if you have the Invoice Settlement feature enabled.\n"
}
}
}
]
}
PostGenerateBillingDocumentType
{
"type": "object",
"example": {
"autoPost": false,
"targetDate": "2017-08-23",
"effectiveDate": "2017-05-23",
"subscriptionIds": [
"4028905558b483220158b48983dd0015",
"6028905558b483220158b68983dd0016"
],
"creditMemoReasonCode": "Unsatisfactory service"
},
"properties": {
"autoPost": {
"enum": [
true,
false
],
"type": "boolean",
"default": false,
"description": "Whether to automatically post the billing documents after the draft billing documents are generated. \n\nIf an error occurs during posting billing documents, the draft billing documents are not generated too.\n"
},
"autoRenew": {
"enum": [
true,
false
],
"type": "boolean",
"default": false,
"description": "Whether to automatically renew the subscriptions with **Auto Renew** set to **Yes**. \n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The date used to determine which charges are to be billed, in `yyyy-mm-dd` format.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date on which to generate the billing documents, in `yyyy-mm-dd` format.\n"
},
"subscriptionIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the subscriptions that you want to create the billing documents for. Each value must be the ID of the latest version of an active subscription.\n"
},
"chargeTypeToExclude": {
"type": "array",
"items": {
"type": "string"
},
"description": "The types of the charges to be excluded from the generation of billing documents. The field values are case insensitive. Supported values include `onetime`, `recurring`, and `usage`. \n"
},
"creditMemoReasonCode": {
"type": "string",
"description": "A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code."
}
}
}
PostInvoiceEmailRequestType
{
"type": "object",
"example": {
"emailAddresses": "contact1@example.com,contact2@example.com",
"useEmailTemplateSetting": false,
"includeAdditionalEmailAddresses": false
},
"properties": {
"emailAddresses": {
"type": "string",
"description": "The valid email addresses you want to email an invoice to. Use commas to separate email addresses.\n**Note:** This field is only applicable if you set the `useEmailTemplateSetting` field to `false`.\n"
},
"useEmailTemplateSetting": {
"enum": [
true,
false
],
"type": "boolean",
"default": false,
"description": "Indicates whether to email an invoice based on the email template setting. \nIf you set this field to `true`, the invoice is sent to the email addresses specified in the **To Email** field of the email template. The email template is the one you set in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. See [Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information about how to edit the **To Email** field in the email template.\n"
},
"includeAdditionalEmailAddresses": {
"enum": [
true,
false
],
"type": "boolean",
"default": false,
"description": "Whether to send an invoice to the additional email addresses of the invoice account. \nYou can set the additional email addresses in the **Additional Email Addresses** field on the account detail page from the Zuora UI. See [Create a Customer Account](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/B_Create_a_Customer_Account#section_2) for more information.\n"
}
}
}
PostInvoiceItemType
{
"allOf": [
{
"type": "object",
"title": "invoiceItems",
"required": [
"amount",
"serviceStartDate"
],
"properties": {
"sku": {
"type": "string",
"description": "The SKU of the invoice item. The SKU of the invoice item must be different from the SKU of any existing product.\n"
},
"uom": {
"type": "string",
"description": "The unit of measure.\n"
},
"amount": {
"type": "string",
"format": "number",
"description": "The amount of the invoice item. \n\n- For tax-inclusive invoice items, the amount indicates the invoice item amount including tax. \n- For tax-exclusive invoice items, the amount indicates the invoice item amount excluding tax.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to the invoice item.\n\n**Note**: This field is only available only if you have Taxation enabled.\n"
},
"taxMode": {
"enum": [
"TaxInclusive",
"TaxExclusive"
],
"type": "string",
"description": "The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.\n\n**Note**: This field is only available only if you have Taxation enabled.\n"
},
"itemType": {
"type": "string",
"description": "The type of the invoice item.\n"
},
"quantity": {
"type": "string",
"format": "number",
"default": "1",
"description": "The number of units for the invoice item.\n"
},
"taxItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostTaxationItemType"
},
"description": "Container for taxation items. The maximum number of taxation items is 5.\n\n**Note**: This field is only available only if you have Taxation enabled.\n"
},
"unitPrice": {
"type": "string",
"format": "number",
"description": "The per-unit price of the invoice item. To pass Level 3 data to the gateway, this field is required and must be greater than zero.\n"
},
"chargeDate": {
"type": "string",
"format": "date-time",
"description": "The date when the invoice item is charged, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"chargeName": {
"type": "string",
"description": "The name of the charge associated with the invoice item. \n\nThis field is required if the `productRatePlanChargeId` field is not specified in the request.\n"
},
"revRecCode": {
"type": "string",
"description": "The revenue recognition code.\n"
},
"description": {
"type": "string",
"description": "The description of the invoice item.\n"
},
"discountItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostDiscountItemType"
},
"description": "Container for discount items. The maximum number of discount items is 10.\n"
},
"accountingCode": {
"type": "string",
"description": "The accounting code associated with the invoice item.\n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The service end date of the invoice item.\n"
},
"bookingReference": {
"type": "string",
"description": "The booking reference of the invoice item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The service start date of the invoice item.\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "The purchase order number associated with the invoice item.\n"
},
"revRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate"
],
"type": "string",
"description": "The date when revenue recognition is triggered.\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of the product rate plan charge that the invoice item is created from.\n\nIf you specify a value for the `productRatePlanChargeId` field in the request, Zuora directly copies the values of the following fields from the corresponding product rate plan charge, regardless of the values specified in the request body:\n- `chargeName`\n- `sku`\n- `uom`\n- `taxCode`\n- `taxMode`\n- `accountingCode`\n- `deferredRevenueAccountingCode` \n- `recognizedRevenueAccountingCode`\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"contractAssetAccountingCode": {
"type": "string",
"description": "The accounting code for contract asset. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment revenue. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for contract liability. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment liability. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"unbilledReceivablesAccountingCode": {
"type": "string",
"description": "The accounting code for unbilled receivables. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for contract recognized revenue. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the invoice item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/InvoiceItemObjectNSFields"
},
{
"$ref": "#/components/schemas/InvoiceItemObjectCustomFields"
}
]
}
PostInvoiceResponse
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the invoice.\n"
},
"amount": {
"type": "string",
"format": "number",
"description": "The total amount of the invoice.\n"
},
"source": {
"enum": [
"BillRun",
"API",
"ApiSubscribe",
"ApiAmend"
],
"type": "string",
"description": "The source of the invoice.\n"
},
"status": {
"enum": [
"Draft",
"Posted"
],
"type": "string",
"description": "The status of the invoice.\n"
},
"autoPay": {
"type": "boolean",
"description": "Whether invoices are automatically picked up for processing in the corresponding payment run.\n"
},
"balance": {
"type": "string",
"format": "number",
"description": "The remaining balance of the invoice after all payments, adjustments, and refunds are applied.\n"
},
"dueDate": {
"type": "string",
"format": "date",
"description": "The date by which the payment for this invoice is due, in `yyyy-mm-dd` format.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"comments": {
"type": "string",
"description": "Comments about the invoice.\n"
},
"currency": {
"type": "string",
"nullable": true,
"description": "The currency of the invoice.\n\n**Note:** By default, the currency on a billing document matches the default currency set on the associated account. \nHowever, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. \nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currency</a>.\n"
},
"discount": {
"type": "string",
"format": "number",
"description": "the invoice discount amount.\n"
},
"postedBy": {
"type": "string",
"description": "The user ID of the person who moved the invoice to Posted status.\n"
},
"sourceId": {
"type": "string",
"description": "The ID of the invoice source.\nIf an invoice is generated from a bill run, the value is the number of the corresponding bill run.Otherwise, the value is `null`.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the invoice.\n"
},
"billRunId": {
"type": "string",
"description": "The id of bill run if the invoice is generated by a bill run.\n"
},
"taxAmount": {
"type": "string",
"format": "number",
"description": "The amount of taxation.\n"
},
"taxStatus": {
"enum": [
"Complete",
"Error",
"UnknownError",
"DuplicateDoc",
"InvalidRequest",
"InvalidResponse",
"TaxEngineError",
"ConcurrentModify",
"InternalServerError",
"TaxCodeTemplateError"
],
"type": "string",
"description": "The status that the tax engine return after it calculates the taxes of this invoice.\n"
},
"postedDate": {
"type": "string",
"format": "date",
"description": "The date when the invoice was posted.\n"
},
"sourceType": {
"enum": [
"Subscription",
"Standalone",
"Order",
"Consolidation"
],
"type": "string",
"description": "The type of the invoice source.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in this bill run.\n"
},
"taxMessage": {
"type": "string",
"description": "The message that the tax engine return if it calculates the taxes of this invoice fails.\n"
},
"templateId": {
"type": "string",
"description": "The ID of the invoice template.\n\n- If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled, the value of this field depends on the configuration of the invoice template. \n - If you specify an invoice template at the subscription level, the value of this field is automatically populated from the corresponding subscription.\n - If you do not specify any invoice template at the subscription level, the value of this field is automatically populated from the corresponding account.\n- If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
},
"createdById": {
"type": "string",
"description": "The user ID of the person who created the invoice. If a bill run generated the invoice, then the value is the user ID of person who created the bill run.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the invoice was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"invoiceDate": {
"type": "string",
"format": "date",
"description": "The date that appears on the invoice being created.\n"
},
"paymentTerm": {
"type": "string",
"description": "The name of payment term associated with the invoice.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the invoice.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date when the invoice was last updated.\n"
},
"refundAmount": {
"type": "string",
"format": "number",
"description": "Specifies the amount of a refund that was applied against an earlier payment on the invoice.\n"
},
"includesUsage": {
"type": "boolean",
"description": "Specifies whether the invoice includes usage charges.\n"
},
"invoiceNumber": {
"type": "string",
"description": "The unique identification number of the invoice.\n"
},
"paymentAmount": {
"type": "string",
"format": "number",
"description": "The amount of payments applied to the invoice.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the invoice.\n"
},
"einvoiceFileId": {
"type": "string",
"description": "The ID of the e-invoice file.\n"
},
"einvoiceStatus": {
"enum": [
"Processing",
"Generated",
"Success",
"Failed"
],
"type": "string",
"description": "It could be Processing, Generated, Success, Failed. If it’s Failed, it will have an error code and message. If it’s Generated or Success, both error code and message are empty, and eInvoiceFileId stores the file id of e-invoice.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the invoice.\n"
},
"includesOneTime": {
"type": "boolean",
"description": "Specifies whether the invoice includes one-time charges.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the invoice.\n"
},
"taxExemptAmount": {
"type": "string",
"format": "number",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"adjustmentAmount": {
"type": "string",
"format": "number",
"description": "The amount of the invoice adjustments associated with the invoice.\n"
},
"amountWithoutTax": {
"type": "string",
"format": "number",
"description": "The invoice amount excluding tax.\n"
},
"creditMemoAmount": {
"type": "string",
"format": "number",
"description": "The currency amount of all credit memos applied to this invoice.\n\n**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"einvoiceErrorCode": {
"type": "string",
"description": "The error code when status is \"Failed\". This code can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor.\n"
},
"includesRecurring": {
"type": "boolean",
"description": "Specifies whether the invoice includes recurring charges.\n"
},
"lastEmailSentDate": {
"type": "string",
"description": "The date when the invoice was last emailed.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"description": "The number of the invoice group associated with the invoice. \n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n"
},
"einvoiceErrorMessage": {
"type": "string",
"description": "The error message when status is \"Failed\". This message can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor.\n"
},
"billToContactSnapshotId": {
"type": "string",
"description": "The ID of the bill-to contact snapshot associated with the invoice.\n"
},
"soldToContactSnapshotId": {
"type": "string",
"description": "The ID of the sold-to contact snapshot associated with the invoice.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Error",
"Ignore",
"Yes",
"No"
],
"type": "string",
"description": "Whether the invoice was transferred to an external accounting system.\n"
},
"creditBalanceAdjustmentAmount": {
"type": "string",
"format": "number",
"description": "The currency amount of the adjustment applied to the customer's credit balance.\n\n **Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.\n"
}
}
},
{
"$ref": "#/components/schemas/InvoiceObjectNSFields"
},
{
"$ref": "#/components/schemas/InvoiceObjectCustomFields"
}
]
}
PostInvoiceType
{
"allOf": [
{
"type": "object",
"title": "invoices",
"required": [
"invoiceDate"
],
"properties": {
"status": {
"enum": [
"Draft",
"Posted"
],
"type": "string",
"default": "Draft",
"description": "The status of invoice. By default, the invoice status is Draft.\n\nWhen creating an invoice, if you set this field to `Posted`, the invoice is created and posted directly.\n"
},
"autoPay": {
"type": "boolean",
"default": false,
"description": "Whether invoices are automatically picked up for processing in the corresponding payment run.\n"
},
"dueDate": {
"type": "string",
"format": "date",
"description": "The date by which the payment for this invoice is due, in `yyyy-mm-dd` format.\n"
},
"comments": {
"type": "string",
"description": "Comments about the invoice.\n"
},
"currency": {
"type": "string",
"description": "The code of a currency as defined in Billing Settings through the Zuora UI.\n\nIf you do not specify a currency during standalone invoice creation, the default account currency is applied. The currency that you specify in the request must be configured and activated in Billing Settings.\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currencies</a> feature enabled.\n"
},
"accountId": {
"type": "string",
"description": "The ID of the account associated with the invoice. \n\nYou must specify either `accountNumber` or `accountId` for a customer account. If both of them are specified, they must refer to the same customer account.\n"
},
"templateId": {
"type": "string",
"description": "The ID of the invoice template associated with the invoice.\n\n**Note**: If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.\n"
},
"customRates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceWithCustomRatesType"
},
"maxItems": 2,
"description": "It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both).\n \n**Note**: The API custom rate feature is permission controlled.\n"
},
"invoiceDate": {
"type": "string",
"format": "date",
"description": "The date that appears on the invoice being created, in `yyyy-mm-dd` format. The value cannot fall in a closed accounting period.\n"
},
"paymentTerm": {
"type": "string",
"description": "The ID or name of the payment term associated with the invoice. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.\n"
},
"sequenceSet": {
"type": "string",
"description": "The ID or name of the sequence set associated with the invoice.\n\n**Note**: If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostInvoiceItemType"
},
"description": "Container for invoice items. The maximum number of invoice items is 1,000.\n\n**Note**: For the \"Create a standalone invoice\" and \"Create standalone invoices\" operations, note the following:\n - If tax has been calculated by an external tax engine, you need to create a standalone invoice with both `invoiceItems` and `taxItems`. The `taxItems` corresponds to the tax information processed by this external tax engine. In this case, you should not specify the `taxMode` and `taxCode` nested fields of the `invoiceItems` field. Instead, you need to specify the `taxMode` and `taxCode` nested fields of the `taxItems` field. You need to specify the `taxMode` field as `TaxExclusive`.\n - If tax has not been calculated by an external tax engine, you can create a standalone invoice only with `invoiceItems`, and decide whether Zuora includes the tax in the quoted charge price and invoice item by specifying the `taxMode` nested field of the `invoiceItems` field as either `TaxExclusive` or `TaxInclusive`. Meanwhile, you need to specify the `taxCode` field, indicating the charge price and invoice item are taxable.\n"
},
"accountNumber": {
"type": "string",
"description": "The Number of the account associated with the invoice.\nYou must specify either `accountNumber` or `accountId` for a customer account. If both of them are specified, they must refer to the same customer account.\n"
},
"billToContact": {
"$ref": "#/components/schemas/PostCreateInvoiceContactType"
},
"invoiceNumber": {
"type": "string",
"description": "A customized invoice number with the following format requirements:\n- Max length: 32 characters\n- Acceptable characters: a-z,A-Z,0-9,-,_,\n\nPurely numerical prefixes or prefixes ending with a number are supported for standalone invoices. For example, you can use `202310000300`, `2003`, `INV202310000300`, or `2023-09-100009785` as invoice numbers.\n\nThe value must be unique in the system, otherwise it may cause issues with bill runs and subscribe/amend. Check out [things to note and troubleshooting steps](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Unified_Invoicing/Import_external_invoices_as_standalone_invoices?#Customizing_invoice_number). \n"
},
"soldToContact": {
"$ref": "#/components/schemas/PostCreateInvoiceContactType"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the invoice. This field is mutually exclusive with the `billToContact` field.\n\n**Note**: If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the invoice. This field is mutually exclusive with the `soldToContact` field.\n\n**Note**: If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.\n"
},
"soldToSameAsBillTo": {
"type": "boolean",
"default": false,
"description": "Whether the sold-to contact and bill-to contact are the same entity. This field is mutually exclusive with the `soldToContact` and `soldToContactId` fields.\n\nThe created invoice has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body:\n\n- This field is set to `true`. \n- A bill-to contact or bill-to contact ID is specified.\n- Neither sold-to contact nor sold-to contact ID is specified.\n\n**Note**: If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Error",
"Ignore",
"Yes",
"No"
],
"type": "string"
}
}
},
{
"$ref": "#/components/schemas/InvoiceObjectNSFields"
},
{
"$ref": "#/components/schemas/InvoiceObjectCustomFields"
}
],
"example": {
"autoPay": false,
"comments": "comments",
"currency": "EUR",
"accountId": "2c9890207863df710178642433c407a5",
"customRates": [
{
"currency": "CAD",
"rateDate": "2022-10-21",
"customFxRate": 2.22
},
{
"currency": "EUR",
"rateDate": "2022-10-21",
"customFxRate": 2.22
}
],
"invoiceDate": "2020-02-01",
"invoiceItems": [
{
"amount": 300,
"quantity": 2,
"taxItems": [
{
"name": "country tax",
"taxCode": "tax code",
"taxDate": "2020-02-01",
"taxMode": "TaxExclusive",
"taxRate": 0.03,
"taxAmount": 9,
"taxRateType": "Percentage",
"exemptAmount": 0,
"jurisdiction": "juristiction",
"locationCode": "locationCode",
"taxCodeDescription": "tax code description",
"taxRateDescription": "tax rate description"
}
],
"chargeDate": "2020-02-01 11:00:00",
"chargeName": "charge with tax amount 9",
"description": "description",
"discountItems": [
{
"sku": "SKU-0002",
"amount": -10,
"taxItems": [
{
"name": "country tax",
"taxCode": "country tax code",
"taxDate": "2021-02-08",
"taxMode": "TaxExclusive",
"taxRate": 0.1,
"taxAmount": -1,
"taxRateType": "Percentage",
"exemptAmount": 0,
"jurisdiction": "jurisdiction",
"locationCode": "locationCode",
"taxCodeDescription": "country tax code, tax rate 10%",
"taxRateDescription": "country tax"
}
],
"chargeDate": "2020-02-01 11:00:00",
"chargeName": "discount",
"description": "description",
"bookingReference": "discountBookingReference"
}
],
"serviceEndDate": "2020-02-10",
"bookingReference": "bookingReference",
"serviceStartDate": "2020-02-01",
"excludeItemBillingFromRevenueAccounting": true
}
],
"invoiceNumber": "6LU5F8NW00001"
}
}
PostMassUpdaterRequest
{
"type": "object",
"required": [
"file",
"params"
],
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "File containing data about the mass action you want to perform. The file requirements are the same as when uploading a file through the Mass Updater in the Zuora UI. The file must be a `.csv` file or a zipped `.csv` file.\n\nThe maximum file size is 4 MB.\n\nThe data in the file must be formatted according to the mass action type you want to perform.\n"
},
"params": {
"type": "string",
"description": "Container for the following fields. You must format this parameter as a JSON object.\n\n* `actionType` (string, **Required**) - Type of mass action you want to perform. The following mass actions are supported: `UpdateAccountingCode`, `CreateRevenueSchedule`, `UpdateRevenueSchedule`, `DeleteRevenueSchedule`, `ImportFXRate`, and `MPU`.\n\n* `checksum` (string) - An MD5 checksum that is used to validate the integrity of\n the uploaded file. The checksum is a 32-character string.\n"
}
}
}
PostNonRefRefundType
{
"allOf": [
{
"type": "object",
"required": [
"totalAmount",
"type"
],
"properties": {
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the refund.\n"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RefundCreditMemoItemType"
},
"description": "Container for credit memo items. The maximum number of items is 1,000.\n\n**Note:** This field 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_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"comment": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "Comments about the refund.\n"
},
"gatewayId": {
"type": "string",
"description": "The ID of the gateway instance that processes the refund. This field can be specified only for electronic refunds. The ID must be a valid gateway instance ID, and this gateway must support the specific payment method. \n\nIf no gateway ID is specified, the default gateway in the billing account configuration will be used. If no gateway is specified in the billing account, the default gateway of the corresponding tenant will be used.\n"
},
"methodType": {
"enum": [
"ACH",
"Cash",
"Check",
"CreditCard",
"PayPal",
"WireTransfer",
"DebitCard",
"CreditCardReferenceTransaction",
"BankTransfer",
"Other"
],
"type": "string",
"description": "How an external refund was issued to a customer. This field is required for an external refund and must be left empty for an electronic refund. You can issue an external refund on a credit memo.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n"
},
"refundDate": {
"type": "string",
"format": "date",
"description": "The date when the refund takes effect, in `yyyy-mm-dd` format. The date of the refund cannot be before the credit memo date. Specify this field only for external refunds. Zuora automatically generates this field for electronic refunds.\n"
},
"customRates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoFromChargeCustomRatesType"
},
"maxItems": 2,
"description": "It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item, Reporting currency item, or both).\n\n**Note**: The API custom rate feature is permission controlled.\n"
},
"referenceId": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n"
},
"totalAmount": {
"type": "number",
"format": "double",
"description": "The total amount of the refund. The amount cannot exceed the unapplied amount of the associated credit memo. If the original credit memo was applied to one or more invoices or debit memos, you have to unapply a full or partial credit memo from the invoices or debit memos, and then refund the full or partial unapplied credit memo to your customers.\n"
},
"gatewayOptions": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The name of a gateway-specific parameter.\n"
},
"value": {
"type": "string",
"description": "The value of the gateway-specific parameter.\n"
}
},
"description": "The field used to pass gateway-specific parameters and parameter values.\n"
},
"softDescriptor": {
"type": "string",
"maxLength": 35,
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi."
},
"paymentMethodId": {
"type": "string",
"description": "The ID of the payment method used for the refund. This field is required for an electronic refund, and the value must be an electronic payment method ID. This field must be left empty for an external refund. \n"
},
"financeInformation": {
"type": "object",
"properties": {
"onAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the unapplied payment.\n"
}
},
"description": "Container for the finance information related to the refund.\n"
},
"softDescriptorPhone": {
"type": "string",
"maxLength": 20,
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi."
},
"secondRefundReferenceId": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
}
}
},
{
"$ref": "#/components/schemas/RefundObjectNSFields"
},
{
"$ref": "#/components/schemas/RefundObjectCustomFields"
}
],
"example": {
"type": "External",
"items": [
{
"amount": 7,
"creditMemoItemId": "4028905f5a890526015a8d73f74b0016"
},
{
"amount": 0.1,
"creditTaxItemId": "4028905f5a890526015a8d73f90c0018"
}
],
"methodType": "CreditCard",
"refundDate": "2017-03-02",
"customRates": [
{
"currency": "CAD",
"rateDate": "2022-10-21",
"customFxRate": 2.22
},
{
"currency": "EUR",
"rateDate": "2022-10-21",
"customFxRate": 1.5
}
],
"totalAmount": 7.1,
"gatewayOptions": {
"Comments": "test",
"IPAddress": "192.168.1.1"
}
}
}
PostOrderLineItemUpdateType
{
"allOf": [
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"format": "UUID",
"description": "The sytem generated Id for the Order Line Item(OLI). Use this field to specify which OLI to update.\n"
}
}
},
{
"$ref": "#/components/schemas/OrderLineItemCommon"
}
]
}
PostOrderLineItemsRequestType
{
"type": "object",
"properties": {
"orderLineItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostOrderLineItemUpdateType"
}
},
"processingOptions": {
"$ref": "#/components/schemas/ProcessingOptions"
}
}
}
PostOrderPreviewResponseType
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"previewResult": {
"$ref": "#/components/schemas/PreviewResult"
}
}
}
]
}
PostOrderResponseType
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"ramps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rampNumber": {
"type": "string",
"maxLength": 50,
"description": "The number of the ramp definition."
},
"subscriptionNumber": {
"type": "string",
"maxLength": 150,
"description": "The number of the subscription that this ramp deal definition is applied to."
}
}
},
"description": "**Note**: This field 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 [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020.\n\nThe ramp definitions created by this order request.\n"
},
"status": {
"enum": [
"Draft",
"Pending",
"Completed"
],
"type": "string",
"description": "Status of the order. `Pending` is only applicable for an order that contains a `CreateSubscription` order action."
},
"orderId": {
"type": "string",
"maxLength": 32,
"description": "The ID of the order created. This field is returned instead of the `orderNumber` field if the `returnIds` query parameter is set to `true`."
},
"refunds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"number": {
"type": "string",
"maxLength": 32,
"description": "The refund number. For example, `R-00009564`."
},
"status": {
"enum": [
"Success",
"Error"
],
"type": "string",
"description": "The status of the refund."
},
"refundInvoiceNumbers": {
"type": "array",
"items": {
"type": "string"
},
"maxLength": 255,
"description": "An array of the refunded invoice numbers generated in this order request."
}
}
}
},
"writeOff": {
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"maximum": 22,
"minimum": 9,
"description": "The amount written off from the invoice balance."
},
"status": {
"enum": [
"Success",
"Failed"
],
"type": "string",
"description": "The status of the write-off."
},
"failedReason": {
"type": "string",
"description": "The reason of write-off failure."
},
"invoiceNumber": {
"type": "string",
"maxLength": 255,
"description": "The number of the invoice that is written off. For example, `INV00051208`."
},
"writeOffCreditMemoNumber": {
"type": "string",
"maxLength": 255,
"description": "The number of the credit memo that is written off."
}
}
}
},
"accountId": {
"type": "string",
"maxLength": 32,
"description": "The account ID for the order. This field is returned instead of the `accountNumber` field if the `returnIds` query parameter is set to `true`."
},
"paymentId": {
"type": "string",
"maxLength": 32,
"description": "The payment Id that is collected in this order request. This field is returned instead of the `paymentNumber` field if the `returnIds` query parameter is set to `true`."
},
"invoiceIds": {
"type": "array",
"items": {
"type": "string"
},
"maxLength": 32,
"description": "An array of the invoice IDs generated in this order request. Normally it includes one invoice ID only, but can include multiple items when a subscription was tagged as invoice separately. This field is returned instead of the `invoiceNumbers` field if the `returnIds` query parameter is set to `true`."
},
"paidAmount": {
"type": "string",
"maxLength": 22,
"minLength": 9,
"description": "The total amount collected in this order request."
},
"orderNumber": {
"type": "string",
"maxLength": 100,
"description": "The order number of the order created."
},
"accountNumber": {
"type": "string",
"maxLength": 50,
"description": "The account number for the order."
},
"creditMemoIds": {
"type": "array",
"items": {
"type": "string"
},
"maxLength": 32,
"description": "An array of the credit memo IDs generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled. This field is returned instead of the `creditMemoNumbers` field if the `returnIds` query parameter is set to `true`."
},
"paymentNumber": {
"type": "string",
"maxLength": 32,
"description": "The payment number that is collected in this order request."
},
"subscriptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"enum": [
"Active",
"Pending Activation",
"Pending Acceptance",
"Cancelled",
"Suspended"
],
"type": "string",
"description": "Status of the subscription. `Pending Activation` and `Pending Acceptance` are only applicable for an order that contains a `CreateSubscription` order action."
},
"subscriptionId": {
"type": "string",
"maxLength": 32,
"description": "Subscription ID of the subscription included in this order. This field is returned instead of the `subscriptionNumber` field if the `returnIds` query parameter is set to `true`."
},
"subscriptionNumber": {
"type": "string",
"maxLength": 150,
"description": "Subscription number of the subscription included in this order."
}
}
},
"description": "**Note:** This field is in Zuora REST API version control. Supported minor versions are 223.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header.\n\nContainer for the subscription numbers and statuses in an order.\n"
},
"invoiceNumbers": {
"type": "array",
"items": {
"type": "string"
},
"maxLength": 255,
"description": "An array of the invoice numbers generated in this order request. Normally it includes one invoice number only, but can include multiple items when a subscription was tagged as invoice separately."
},
"orderLineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"description": "The sytem generated Id for the Order Line Item."
},
"itemNumber": {
"type": "string",
"maxLength": 100,
"description": "The number for the Order Line Item."
}
}
}
},
"subscriptionIds": {
"type": "array",
"items": {
"type": "string"
},
"maxLength": 32,
"description": "Container for the subscription IDs of the subscriptions in an order. This field is returned if the `returnIds` query parameter is set to `true`."
},
"creditMemoNumbers": {
"type": "array",
"items": {
"type": "string"
},
"maxLength": 255,
"description": "An array of the credit memo numbers generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled."
},
"subscriptionNumbers": {
"type": "array",
"items": {
"type": "string"
},
"maxLength": 150,
"description": "Container for the subscription numbers of the subscriptions in an order. Subscriptions in the response are displayed in the same sequence as the subscriptions defined in the request."
}
}
}
],
"description": "Response information of orders."
}
PostPreviewOrderAsynchronouslyResponse
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"format": "UUID",
"description": "The ID of an asynchronous job that will be returned for tracking the status and result of the job."
}
}
}
PostRefundType
{
"allOf": [
{
"type": "object",
"required": [
"totalAmount",
"type"
],
"properties": {
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the refund.\n"
},
"comment": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "Comments about the refund.\n"
},
"methodType": {
"enum": [
"ACH",
"Cash",
"Check",
"CreditCard",
"PayPal",
"WireTransfer",
"DebitCard",
"CreditCardReferenceTransaction",
"BankTransfer",
"Other"
],
"type": "string",
"description": "How an external refund was issued to a customer. This field is required for an external refund and must be left empty for an electronic refund. You can issue an external refund on an electronic payment.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n"
},
"refundDate": {
"type": "string",
"format": "date",
"description": "The date when the refund takes effect, in `yyyy-mm-dd` format. The date of the refund cannot be before the payment date. Specify this field only for external refunds. Zuora automatically generates this field for electronic refunds.\n"
},
"customRates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentWithCustomRatesType"
},
"maxItems": 2,
"description": "It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item, Reporting currency item, or both).\n\n**Note**: The API custom rate feature is permission controlled.\n"
},
"referenceId": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n"
},
"totalAmount": {
"type": "number",
"format": "double",
"description": "The total amount of the refund. The amount cannot exceed the unapplied amount of the associated payment. If the original payment was applied to one or more invoices or debit memos, you have to unapply a full or partial payment from the invoices or debit memos, and then refund the full or partial unapplied payment to your customers. \n"
},
"gatewayOptions": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The name of a gateway-specific parameter.\n"
},
"value": {
"type": "string",
"description": "The value of the gateway-specific parameter.\n"
}
},
"description": "The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).\n\nZuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.\n"
},
"softDescriptor": {
"type": "string",
"maxLength": 35,
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi."
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the unapplied payment.\n"
}
},
"description": "Container for the finance information related to the refund.\n"
},
"softDescriptorPhone": {
"type": "string",
"maxLength": 20,
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi."
},
"refundTransactionType": {
"enum": [
"Chargeback",
"PaymentReversal"
],
"type": "string",
"description": "The transaction type of the refund.\n"
},
"secondRefundReferenceId": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
}
}
},
{
"$ref": "#/components/schemas/RefundObjectNSFields"
},
{
"$ref": "#/components/schemas/RefundObjectCustomFields"
}
],
"example": {
"type": "External",
"comment": "Create a refund for unapplied payment.",
"methodType": "CreditCard",
"reasonCode": "Standard Refund",
"refundDate": "2017-03-01",
"customRates": [
{
"currency": "CAD",
"rateDate": "2022-10-21",
"customFxRate": 2.22
},
{
"currency": "EUR",
"rateDate": "2022-10-21",
"customFxRate": 2.22
}
],
"totalAmount": 4,
"gatewayOptions": {
"Comments": "test",
"IPAddress": "192.168.1.1"
},
"refundTransactionType": "Chargeback"
}
}
PostRefundwithAutoUnapplyType
{
"allOf": [
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"External",
"Electronic"
],
"type": "string",
"description": "The type of the refund.\n"
},
"comment": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "Comments about the refund.\n"
},
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentInvoiceApplicationApplyRequestType"
},
"description": "Container for invoices. The maximum number of invoices is 1,000.\n"
},
"writeOff": {
"type": "boolean",
"default": false,
"description": "Indicates whether to write off a document.\n"
},
"debitMemos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentDebitMemoApplicationApplyRequestType"
},
"description": "Container for debit memos. The maximum number of debit memos is 1,000.\n"
},
"methodType": {
"enum": [
"ACH",
"Cash",
"Check",
"CreditCard",
"PayPal",
"WireTransfer",
"DebitCard",
"CreditCardReferenceTransaction",
"BankTransfer",
"Other"
],
"type": "string",
"description": "How an external refund was issued to a customer. This field is required for an external refund and must be left empty for an electronic refund. You can issue an external refund on an electronic payment.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.\n"
},
"refundDate": {
"type": "string",
"format": "date",
"description": "The date when the refund takes effect, in `yyyy-mm-dd` format. The date of the refund cannot be before the payment date. Specify this field only for external refunds. Zuora automatically generates this field for electronic refunds.\n"
},
"referenceId": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.\n"
},
"totalAmount": {
"type": "number",
"format": "double",
"description": "The total amount of the refund. If you do not specify a value, Zuora initiates a full refund of the payment amount, which is the sum of the applied and unapplied payment amounts.\n\n - `Full Refund`: If the refund amount and debit memo/ invoice are not specified, then the payment will be unapplied completely, followed by processing a full refund.\n - `Partial Refund`:\n - If the total amount is specified, and the debit memo/invoice is not specified, you can unapply the refund amount from the available debit memo/invoice and refund the unapplied payment to the customer.\n - If the total amount is specified, along with the debit memo and the invoice, you can unapply the applied payments from the mentioned invoices and debit memos, and refund the unapplied payments to customers. \n"
},
"gatewayOptions": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The name of a gateway-specific parameter.\n"
},
"value": {
"type": "string",
"description": "The value of the gateway-specific parameter.\n"
}
},
"description": "The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).\n\nZuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.\n"
},
"softDescriptor": {
"type": "string",
"maxLength": 35,
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi."
},
"writeOffOptions": {
"type": "object",
"default": false,
"properties": {
"comment": {
"type": "string",
"maxLength": 100,
"description": "Comments about the credit memo which is created as a result of the write off.\n"
},
"memoDate": {
"type": "string",
"format": "date",
"description": "The date when the credit memo takes effect.\n"
},
"reasonCode": {
"type": "string",
"description": "A code identifying the reason for the credit memo.\n"
}
},
"description": "Container for the write-off information to create credit memo.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the unapplied payment.\n"
}
},
"description": "Container for the finance information related to the refund.\n"
},
"softDescriptorPhone": {
"type": "string",
"maxLength": 20,
"description": "A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi."
},
"refundTransactionType": {
"enum": [
"Chargeback",
"PaymentReversal"
],
"type": "string",
"description": "The transaction type of the refund.\n"
},
"secondRefundReferenceId": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.\n"
}
}
},
{
"$ref": "#/components/schemas/RefundObjectNSFields"
},
{
"$ref": "#/components/schemas/RefundObjectCustomFields"
}
],
"example": {
"type": "External",
"comment": "Create a refund for unapplied payment.",
"methodType": "CreditCard",
"reasonCode": "Standard Refund",
"refundDate": "2017-03-01",
"totalAmount": 100,
"gatewayOptions": {
"Comments": "test",
"IPAddress": "192.168.1.1"
},
"refundTransactionType": "Chargeback"
}
}
PostScheduledEventRequest
{
"type": "object",
"example": {
"name": "TermEndDateScheduledEvent",
"hours": 10,
"active": true,
"minutes": 30,
"apiField": "TermEndDate",
"apiObject": "Subscription",
"condition": "Subscription.Status == _SUBSCRIPTION_STATUS",
"parameters": {
"_SUBSCRIPTION_STATUS": {
"options": [
"Draft",
"Active",
"Pending",
"Expired",
"Cancelled"
],
"valueType": "STRING",
"description": "The status of the subscription",
"displayName": "Subscription Status"
}
},
"description": "Trigger a scheduled event at 10:30 AM based on TermEndDate of subscription objects.",
"displayName": "Term End Date Scheduled Event"
},
"required": [
"name",
"displayName",
"apiObject",
"apiField",
"hours",
"minutes"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The name of the scheduled event. Should be unique, contain no space, and be in the pattern: ^[A-Za-z]{1,}[\\\\w\\\\-]*$"
},
"hours": {
"type": "integer",
"maximum": 23,
"minimum": 0,
"description": "The scheduled time (hour) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant."
},
"active": {
"type": "boolean",
"default": true,
"description": "Indicate whether the scheduled event is active or inactive."
},
"minutes": {
"type": "integer",
"maximum": 59,
"minimum": 0,
"description": "The scheduled time (minute) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant."
},
"apiField": {
"type": "string",
"description": "The base field of the base object in the `apiObject` field, should be in date or timestamp format. The scheduled event notifications are triggered based on this date and the event parameters (before or after a specified number of days) from notification definitions. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$\n \nSee [Custom Scheduled Events](https://knowledgecenter.zuora.com/Central_Platform/Events_and_Notifications/A_Z_Custom_Scheduled_Events) for all available base fields.\n"
},
"apiObject": {
"type": "string",
"description": "The base object that the scheduled event is defined upon. The base object should contain a date or timestamp format field. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$\n \nSee [Custom Scheduled Events](https://knowledgecenter.zuora.com/Central_Platform/Events_and_Notifications/A_Z_Custom_Scheduled_Events) for all available base objects.\n"
},
"condition": {
"type": "string",
"maxLength": 65535,
"description": "The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The scheduled event is triggered only if the condition is evaluated as true.\nThe rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects).\nScheduled events with invalid merge fields will fail to evaluate, thus will not be triggered. For example, to trigger an invoice due date scheduled event to only invoices with an amount over 1000, you would define the following condition:\n\n```Invoice.Amount > 1000```\n\n`Invoice.Amount` refers to the `Amount` field of the Zuora object `Invoice`.\n"
},
"parameters": {
"type": "object",
"description": "The parameter definitions of the filter rule. The names of the parameters must match with the filter rule and can't be duplicated. You should specify all the parameters when creating scheduled event notifications.",
"additionalProperties": {
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "The option values of the parameter."
},
"valueType": {
"enum": [
"STRING",
"BYTE",
"SHORT",
"CHARACTER",
"INTEGER",
"LONG",
"FLOAT",
"DOUBLE",
"BOOLEAN",
"BIG_INTEGER",
"BIG_DECIMAL",
"LOCAL_DATE",
"LOCAL_DATE_TIME",
"TIMESTAMP",
"BYTE_ARRAY",
"SHORT_ARRAY",
"CHARACTER_ARRAY",
"INTEGER_ARRAY",
"FLOAT_ARRAY",
"DOUBLE_ARRAY",
"BOOLEAN_ARRAY",
"STRING_ARRAY",
"BIG_INTEGER_ARRAY",
"BIG_DECIMAL_ARRAY",
"LOCAL_DATE_ARRAY",
"LOCAL_DATE_TIME_ARRAY",
"TIMESTAMP_ARRAY"
],
"type": "string",
"description": "The type of the value."
},
"description": {
"type": "string",
"maxLength": 255,
"description": "The description of the parameter."
},
"displayName": {
"type": "string",
"maxLength": 255,
"description": "The display name of the parameter."
}
},
"description": "Definition of a filter rule parameter."
}
},
"description": {
"type": "string",
"maxLength": 1000,
"description": "The description of the scheduled event."
},
"displayName": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "The display name of the scheduled event."
}
},
"description": "namespace.name pair should be unique universally"
}
PostTaxationItemType
{
"allOf": [
{
"type": "object",
"title": "taxItems",
"required": [
"name",
"taxAmount",
"taxCode",
"taxDate",
"taxMode",
"taxRate",
"taxRateType"
],
"properties": {
"name": {
"type": "string",
"description": "The name of taxation.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific invoice item.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date that the tax is applied to the invoice item, in `yyyy-mm-dd` format.\n"
},
"taxMode": {
"enum": [
"TaxInclusive",
"TaxExclusive"
],
"type": "string",
"description": "The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.\n"
},
"taxRate": {
"type": "string",
"format": "number",
"description": "The tax rate applied to the invoice item.\n"
},
"taxAmount": {
"type": "string",
"format": "number",
"description": "The amount of the taxation item in the invoice item.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate applied to the invoice item.\n"
},
"exemptAmount": {
"type": "string",
"format": "number",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
}
}
},
{
"$ref": "#/components/schemas/TaxationItemObjectCustomFields"
}
]
}
PostUploadFileForCreditMemoRequest
{
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "The PDF file to upload for the credit memo.\n"
}
}
}
PostUploadFileForCustomObjectBulkJobRequest
{
"type": "string",
"description": "The CSV file to be uploaded. The file must be encoded in UTF-8 and the file size limit is 15 MB."
}
PostUploadFileForDebitMemoRequest
{
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "The PDF file to upload for the debit memo.\n"
}
}
}
PostUploadFileForInvoiceRequest
{
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "The PDF file to upload for the invoice.\n"
}
}
}
PostUsageRequest
{
"type": "object",
"required": [
"file"
],
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "The usage data to import. The supported formats are excel, csv, and zip.\n"
}
}
}
PostWorkflowVersionsImportRequest
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Task"
}
},
"linkages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Linkage"
}
},
"workflow": {
"$ref": "#/components/schemas/DetailedWorkflow"
}
}
}
PreviewAccountInfo
{
"type": "object",
"title": "previewAccountInfo",
"required": [
"currency",
"billCycleDay"
],
"properties": {
"taxInfo": {
"$ref": "#/components/schemas/TaxInfo"
},
"currency": {
"type": "string",
"maxLength": 3,
"description": "ISO 3-letter currency code (uppercase). For example, USD.\n"
},
"billCycleDay": {
"type": "integer",
"maximum": 31,
"minimum": 0,
"description": "Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\"."
},
"customFields": {
"$ref": "#/components/schemas/AccountObjectCustomFields"
},
"soldToContact": {
"$ref": "#/components/schemas/PreviewContactInfo"
}
},
"description": "Information about the account that will own the order.\n"
}
PreviewContactInfo
{
"type": "object",
"properties": {
"city": {
"type": "string",
"maxLength": 40
},
"state": {
"type": "string",
"maxLength": 40
},
"county": {
"type": "string",
"maxLength": 32
},
"country": {
"type": "string",
"maxLength": 64,
"description": "Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country to calculate tax."
},
"taxRegion": {
"type": "string",
"maxLength": 32
},
"postalCode": {
"type": "string",
"maxLength": 20
}
}
}
PreviewExistingSubscriptionCreditMemoItemResult
{
"type": "object",
"properties": {
"quantity": {
"type": "number",
"description": "The quantity of the charge."
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The tax amount of the credit memo item."
},
"unitPrice": {
"type": "number",
"format": "double",
"description": "The unit price of the charge."
},
"chargeName": {
"type": "string",
"description": "Name of the charge."
},
"productName": {
"type": "string",
"description": "Name of the product."
},
"chargeNumber": {
"type": "string",
"description": "Available when the `chargeNumber` field was specified in the request or when the order is amending an existing subscription."
},
"unitOfMeasure": {
"type": "string",
"nullable": true,
"description": "The unit of measure of the charge."
},
"processingType": {
"enum": [
"Charge",
"Discount",
"Tax"
],
"type": "string",
"description": "The processing type of the credit memo item."
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd."
},
"discountDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreviewExistingSubscriptionDiscountDetails"
},
"description": "Container for discount details."
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "Credit memo amount minus tax."
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge."
},
"chargeDescription": {
"type": "string",
"description": "Description of the charge."
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of the product rate plan charge."
}
}
}
PreviewExistingSubscriptionDiscountDetails
{
"type": "object",
"properties": {
"discountRate": {
"type": "number",
"description": "The discount rate."
},
"discountChargeNumber": {
"type": "string",
"description": "The charge number of the discount."
}
}
}
PreviewExistingSubscriptionInvoiceItemResult
{
"type": "object",
"properties": {
"quantity": {
"type": "number",
"description": "The quantity of the charge."
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The tax amount of the invoice item."
},
"unitPrice": {
"type": "number",
"format": "double",
"description": "The unit price of the charge."
},
"chargeName": {
"type": "string",
"description": "Name of the charge."
},
"productName": {
"type": "string",
"description": "Name of the product."
},
"chargeNumber": {
"type": "string",
"description": "Available when the `chargeNumber` field was specified in the request or when the order is amending an existing subscription."
},
"unitOfMeasure": {
"type": "string",
"nullable": true,
"description": "The unit of measure of the charge."
},
"processingType": {
"enum": [
"Charge",
"Discount",
"Tax"
],
"type": "string",
"description": "The processing type of the invoice item."
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd."
},
"discountDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreviewExistingSubscriptionDiscountDetails"
},
"description": "Container for discount details."
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "Invoice amount minus tax."
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge."
},
"chargeDescription": {
"type": "string",
"description": "Description of the charge."
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of the product rate plan charge."
}
}
}
PreviewExistingSubscriptionRequest
{
"type": "object",
"example": {
"previewStartDate": {
"specificDate": "2024-01-01",
"previewStartDatePolicy": "specificDate"
},
"previewThroughDate": {
"nextBillingPeriods": "2",
"previewThruDatePolicy": "nextBillingPeriods"
},
"quantityForUsageCharges": [
{
"chargeId": "402880e78ccd1743018cce026efb002d",
"quantity": 20
}
]
},
"properties": {
"previewStartDate": {
"$ref": "#/components/schemas/PreviewStartDate"
},
"previewThroughDate": {
"$ref": "#/components/schemas/PreviewThroughDate"
},
"quantityForUsageCharges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuantityForUsageCharges"
},
"description": "Container for usage charges.\n"
}
},
"description": "Preview the existing subscription by subscription ID or number.\n"
}
PreviewExistingSubscriptionResponse
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreviewExistingSubscriptionResultInvoices"
},
"description": "Container for invoices."
},
"creditMemos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreviewExistingSubscriptionResultCreditMemos"
},
"description": "Container for credit memos.\n\n**Note**: This field is only available if you have the Invoice Settlement feature enabled.\n"
}
}
}
]
}
PreviewExistingSubscriptionResultCreditMemos
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "Credit memo amount."
},
"status": {
"type": "string",
"description": "The status of the credit memo."
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The tax amount of the credit memo."
},
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if a credit memo is generated, as yyyy-mm-dd."
},
"creditMemoItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreviewExistingSubscriptionCreditMemoItemResult"
},
"description": "Container for credit memo items."
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "Credit memo amount minus tax."
},
"creditMemoNumber": {
"type": "string",
"description": "The credit memo number."
},
"isFromExistingCreditMemo": {
"type": "boolean",
"description": "Indicates whether the credit memo information is from an existing credit memo."
}
}
}
PreviewExistingSubscriptionResultInvoices
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "Invoice amount.\n"
},
"status": {
"enum": [
"Draft",
"Posted"
],
"type": "string",
"description": "The status of the invoice.\n"
},
"taxAmount": {
"type": "number",
"format": "double",
"description": "The tax amount of the invoice.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreviewExistingSubscriptionInvoiceItemResult"
},
"description": "The container for invoice items.\n"
},
"invoiceNumber": {
"type": "string",
"description": "The invoice number.\n"
},
"amountWithoutTax": {
"type": "number",
"format": "double",
"description": "Invoice amount minus tax.\n"
},
"isFromExistingInvoice": {
"type": "boolean",
"description": "Indicates whether the invoice information is from an existing invoice.\n"
}
}
}
PreviewOptions
{
"type": "object",
"properties": {
"previewTypes": {
"type": "array",
"items": {
"enum": [
"ChargeMetrics",
"BillingDocs",
"OrderDeltaMetrics",
"OrderMetrics",
"RampMetrics",
"RampDeltaMetrics"
],
"type": "string"
},
"description": "One or more types of the preview. It can include:\n\n* ChargeMetrics: charge level metrics will be returned in the response, including: `cmrr`, `tcv`, `tcb`, and `tax`.\n* BillingDocs: `invoices` and `creditMemos` will be returned in the response. Note `creditMemos` is only available if the Invoice Settlement feature is enabled.\n* OrderDeltaMetrics: order delta metrics will be returned in the response, including: `orderDeltaMrr`, `orderDeltaTcb` and `orderDeltaTcv`.\n* OrderMetrics: order metrics will be returned in the response, including: `quantity`, `mrr`, `tcb`, `tcv`, and `elp`. **Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the OrderDeltaMetrics. It is recommended that all customers use the [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/). Whereas new customers, and existing customers not currently on [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders), will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported.\n* RampMetrics: ramp metrics will be returned in the response, including: `quantity`, `mrr`, `tcb`, `tcv` metrics for each charge and each ramp interval.\n* RampDeltaMetrics: ramp metrics changes will be returned in the response, including: `deltaQuantity`, `deltaMrr`, `deltaTcb`, `deltaTcv` metrics for each charge and each ramp interval.\n"
},
"previewThruType": {
"enum": [
"SpecificDate",
"TermEnd",
"NumberOfPeriods"
],
"type": "string",
"description": "The options on how the preview through date is calculated. Available for preview only. \n- If you set this field to `SpecificDate`, you must specify a specific date in the `specificPreviewThruDate` field. If you also set `billTargetDate` in the `orderLineItems` field, order line items whose `billTargetDate` is no later than `specificPreviewThruDate` are returned.\n\n- If you set this field to `NumberOfPeriods`, you must use the `previewNumberOfPeriods` field to specify how many periods you want to preview. In case the order only contains an order line item but not contains a subscription, if you also set `billTargetDate` in the `orderLineItems` field, order line items whose `billTargetDate` is no later than today are returned.\n\n- The `TermEnd` option is invalid when any subscription included in this order is evergreen. In case the order only contains an order line item but not contains a subscription, if you set this field to `TermEnd` and set `billTargetDate` in the `orderLineItems` field, order line items whose `billTargetDate` is no later than today are returned.\n"
},
"previewNumberOfPeriods": {
"type": "integer",
"minLength": 1,
"description": "The number of periods to preview when the value of the `previewThroughType` field is set to `NumberOfPeriods`.\n"
},
"specificPreviewThruDate": {
"type": "string",
"format": "date",
"description": "The end date of the order preview. You can preview the invoice charges through the preview through date. (Invoice preview only)\n\n\n**Note:** This field is only applicable if the 'previewThruType' field is set to 'SpecificDate'.\n"
}
}
}
PreviewOrderChargeOverride
{
"type": "object",
"title": "charge",
"required": [
"productRatePlanChargeId"
],
"properties": {
"name": {
"type": "string",
"description": "The name of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"billing": {
"type": "object",
"properties": {
"billCycleDay": {
"type": "integer",
"maximum": 31,
"minimum": 0,
"description": "Day of the month that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofMonth`.\n"
},
"billCycleType": {
"enum": [
"DefaultFromCustomer",
"SpecificDayofMonth",
"SubscriptionStartDay",
"ChargeTriggerDay",
"SpecificDayofWeek"
],
"type": "string",
"description": "Specifies how Zuora determines the day that each billing period begins on.\n\n * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.\n * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.\n * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.\n * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.\n * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.\n"
},
"billingPeriod": {
"enum": [
"Month",
"Quarter",
"Semi_Annual",
"Annual",
"Eighteen_Months",
"Two_Years",
"Three_Years",
"Five_Years",
"Specific_Months",
"Subscription_Term",
"Week",
"Specific_Weeks",
"Specific_Days"
],
"type": "string",
"description": "Billing frequency of the charge. The value of this field controls the duration of each billing period.\n\nIf the value of this field is `Specific_Days`, `Specific_Months` or `Specific_Weeks`, use the `specificBillingPeriod` field to specify the duration of each billing period.\n"
},
"billingTiming": {
"enum": [
"IN_ADVANCE",
"IN_ARREARS"
],
"type": "string",
"description": "Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).\n"
},
"weeklyBillCycleDay": {
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string",
"description": "Day of the week that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofWeek`.\n"
},
"specificBillingPeriod": {
"type": "integer",
"description": "Duration of each billing period in months or weeks, depending on the value of the `billingPeriod` field. Only applicable if the value of the `billingPeriod` field is `Specific_Months` or `Specific_Weeks`.\n"
},
"billingPeriodAlignment": {
"enum": [
"AlignToCharge",
"AlignToSubscriptionStart",
"AlignToTermStart"
],
"type": "string",
"description": "Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges.\n\n* `AlignToCharge` - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active.\n* `AlignToSubscriptionStart` - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription.\n* `AlignToTermStart` - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term.\n\nSee the `billCycleType` field for information about how Zuora determines the billing day.\n"
}
},
"description": "Billing information about the charge.\n"
},
"endDate": {
"$ref": "#/components/schemas/EndConditions"
},
"pricing": {
"type": "object",
"properties": {
"discount": {
"$ref": "#/components/schemas/DiscountPricingOverride"
},
"usageTiered": {
"$ref": "#/components/schemas/UsageTieredPricingOverride"
},
"usageVolume": {
"$ref": "#/components/schemas/UsageVolumePricingOverride"
},
"usageFlatFee": {
"$ref": "#/components/schemas/UsageFlatFeePricingOverride"
},
"usageOverage": {
"$ref": "#/components/schemas/UsageOveragePricingOverride"
},
"usagePerUnit": {
"$ref": "#/components/schemas/UsagePerUnitPricingOverride"
},
"oneTimeTiered": {
"$ref": "#/components/schemas/OneTimeTieredPricingOverride"
},
"oneTimeVolume": {
"$ref": "#/components/schemas/OneTimeVolumePricingOverride"
},
"oneTimeFlatFee": {
"$ref": "#/components/schemas/OneTimeFlatFeePricingOverride"
},
"oneTimePerUnit": {
"$ref": "#/components/schemas/OneTimePerUnitPricingOverride"
},
"chargeModelData": {
"$ref": "#/components/schemas/ChargeModelDataOverride"
},
"recurringTiered": {
"$ref": "#/components/schemas/RecurringTieredPricingOverride"
},
"recurringVolume": {
"$ref": "#/components/schemas/RecurringVolumePricingOverride"
},
"recurringFlatFee": {
"$ref": "#/components/schemas/RecurringFlatFeePricingOverride"
},
"recurringPerUnit": {
"$ref": "#/components/schemas/RecurringPerUnitPricingOverride"
},
"recurringDeliveryBased": {
"$ref": "#/components/schemas/RecurringDeliveryPricingOverride"
},
"usageTieredWithOverage": {
"$ref": "#/components/schemas/UsageTieredWithOveragePricingOverride"
}
},
"description": "Pricing information about the charge.\n"
},
"taxCode": {
"type": "string",
"description": "The taxCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"taxMode": {
"type": "string",
"description": "The taxMode of a standalone charge. \nValues:\n* `TaxExclusive`\n* `TaxInclusive`\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"pobPolicy": {
"type": "string",
"description": "The pobPolicy of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"startDate": {
"$ref": "#/components/schemas/PreviewOrderTriggerParams"
},
"chargeType": {
"type": "string",
"description": "The chargeType of a standalone charge.\nSupported charge types:\n* `OneTime`\n* `Recurring`\n* `Usage`\n* `DiscountFixedAmount`\n* `DiscountPercentage`\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"isRollover": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe value is either \"True\" or \"False\". It determines whether the rollover fields are needed.\n"
},
"isUnbilled": {
"type": "boolean",
"description": "This field is used to dictate how to perform the accounting during revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"revRecCode": {
"type": "string",
"maxLength": 70,
"description": "Revenue Recognition Code\n"
},
"chargeModel": {
"type": "string",
"description": "The chargeModel of a standalone charge.\nSupported charge models:\n* `FlatFee`\n* `PerUnit`\n* `Volume`\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"description": {
"type": "string",
"maxLength": 500,
"description": "Description of the charge.\n"
},
"productLine": {
"type": "string",
"description": "The productLine of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"uniqueToken": {
"type": "string",
"maxLength": 50,
"description": "Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.\n"
},
"chargeNumber": {
"type": "string",
"maxLength": 50,
"description": "Charge number of the charge. For example, C-00000307.\n\nIf you do not set this field, Zuora will generate the charge number.\n"
},
"customFields": {
"$ref": "#/components/schemas/RatePlanChargeObjectCustomFields"
},
"drawdownRate": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0).\n"
},
"productClass": {
"type": "string",
"description": "The productClass of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"productFamily": {
"type": "string",
"description": "The productFamily of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"rolloverApply": {
"enum": [
"ApplyFirst",
"ApplyLast"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the priority of rollover, which is either first or last.\n"
},
"prepaidQuantity": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0).\n"
},
"productCategory": {
"type": "string",
"description": "The productCategory of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"rolloverPeriods": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThis field defines the number of rollover periods, it is restricted to 3.\n"
},
"validityPeriodType": {
"enum": [
"SUBSCRIPTION_TERM",
"ANNUAL",
"SEMI_ANNUAL",
"QUARTER",
"MONTH"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). \n"
},
"isAllocationEligible": {
"type": "boolean",
"description": "This field is used to identify if the charge segment is allocation eligible in revenue recognition.\n\n**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at <a href=\"https://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a>, and we will evaluate whether the feature is suitable for your use cases.\n"
},
"rolloverPeriodLength": {
"type": "integer",
"default": null,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe period length of the rollover fund.\n"
},
"revRecTriggerCondition": {
"enum": [
"Contract Effective Date",
"Service Activation Date",
"Customer Acceptance Date"
],
"type": "string",
"description": "Specifies the revenue recognition trigger condition.\n\n * `Contract Effective Date` \n * `Service Activation Date`\n * `Customer Acceptance Date`\n"
},
"productRatePlanChargeId": {
"type": "string",
"description": "Internal identifier of the product rate plan charge that the charge is based on.\n"
},
"upsellOriginChargeNumber": {
"type": "string",
"description": "The identifier of the original upselling charge associated with the current charge.\n\nFor a termed subscription, you can now use the \"Create an order\" API operation to perform an Add Product order action to make a product quantity upsell for per unit recurring charges. The benefit is that the charge added by this approach will be automatically combined with the original existing charge for which you want to upsell when the subscription is renewed. The approach is as follows:\n* Use an Add Product order action to add a charge that is of the same charge type, charge model, and charge end date as the existing per unit recurring charge for which you want to make a quantity upsell.\n\n* In the preceding charge to add, use the `upsellOriginChargeNumber` field to specify the existing rate plan charge for which you want to make the quantity upsell.\n\nNote that a termed subscription with such upsell charges can not be changed to an evergreen subscription. \n\n**Note**: The Quantity Upsell 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. If you want to join this early adopter program, submit a request at [Zuora Global\n Support](https://support.zuora.com). \n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "Specifies the revenue recognition rule, such as `Recognize upon invoicing` or `Recognize daily over time`.\n"
},
"contractAssetAccountingCode": {
"type": "string",
"description": "The contractAssetAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"productRatePlanChargeNumber": {
"type": "string",
"description": "Number of a product rate-plan charge for this subscription.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The deferredRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> and <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a> features are enabled.\n"
},
"accountReceivableAccountingCode": {
"type": "string",
"description": "The accountReceivableAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a>, <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a>, and <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Get_started_with_Invoice_Settlement/AA_Overview_of_Invoice_Settlement\" target=\"_blank\">Invoice Settlement</a> features are enabled.\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The adjustmentRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The contractLiabilityAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The recognizedRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> and <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance\" target=\"_blank\">Zuora Finance</a> features are enabled.\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The adjustmentLiabilityAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"unBilledReceivablesAccountingCode": {
"type": "string",
"description": "The unBilledReceivablesAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The contractRecognizedRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature and the <a href=\"https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration\" target=\"_blank\">Billing - Revenue Integration</a> or <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Order_to_Revenue_introduction/AA_Overview_of_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> feature are enabled.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\nIf both the following features in <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing\" target=\"_blank\">Advanced Consumption Billing</a> are enabled in your tenant, you must ensure the `excludeItemBillingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the `excludeItemBookingFromRevenueAccounting` field in a Create Subscription or Add Product order action is set to `false`, you must also set the `excludeItemBillingFromRevenueAccounting` field in this order action to `false`.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled.\n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude rate plan charges from revenue accounting.\n\nIf both the following features in <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing\" target=\"_blank\">Advanced Consumption Billing</a> are enabled in your tenant, you must ensure the `excludeItemBookingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge.\n * Prepaid with Drawdown\n * Unbilled Usage\n\n**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue\" target=\"_blank\">Order to Revenue</a> or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled.\n"
}
},
"description": "Charge associated with a rate plan.\n"
}
PreviewOrderChargeUpdate
{
"type": "object",
"properties": {
"billing": {
"$ref": "#/components/schemas/BillingUpdate"
},
"pricing": {
"$ref": "#/components/schemas/PreviewOrderPricingUpdate"
},
"description": {
"type": "string"
},
"uniqueToken": {
"type": "string",
"description": "A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions.\n"
},
"chargeNumber": {
"type": "string",
"description": "The number of the charge to be updated. The value of this field is inherited from the `subscriptions` > `orderActions` > `addProduct` > `chargeOverrides` > `chargeNumber` field.\n"
},
"customFields": {
"$ref": "#/components/schemas/RatePlanChargeObjectCustomFields"
},
"effectiveDate": {
"$ref": "#/components/schemas/PreviewOrderTriggerParams"
},
"prepaidQuantity": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0). \n"
}
},
"x-konfig-properties": {
"pricing": {
"description": "Pricing information about the charge.\n"
}
}
}
PreviewOrderCreateSubscription
{
"type": "object",
"title": "createSubscription",
"properties": {
"notes": {
"type": "string",
"maxLength": 500,
"description": "Notes about the subscription. These notes are only visible to Zuora users.\n"
},
"terms": {
"type": "object",
"required": [
"initialTerm"
],
"properties": {
"autoRenew": {
"type": "boolean",
"description": "Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is `TERMED`.\n"
},
"initialTerm": {
"type": "object",
"required": [
"termType"
],
"properties": {
"period": {
"type": "integer",
"description": "Duration of the first term in months, years, days, or weeks, depending on the value of the `periodType` field. Only applicable if the value of the `termType` field is `TERMED`.\n"
},
"endDate": {
"type": "string",
"format": "date",
"description": "End date of the first term, in YYYY-MM-DD format.\n"
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN"
],
"type": "string",
"description": "Type of the first term. If the value of this field is `TERMED`, the first term has a predefined duration based on the value of the `period` field. If the value of this field is `EVERGREEN`, the first term does not have a predefined duration.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "Start date of the first term, in YYYY-MM-DD format.\n"
},
"periodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"description": "Unit of time that the first term is measured in. Only applicable if the value of the `termType` field is `TERMED`.\n"
}
},
"description": "Information about the first term of the subscription.\n"
},
"renewalTerms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RenewalTerm"
},
"description": "List of renewal terms of the subscription. Only applicable if the type of the first term is `TERMED` and the value of the `renewalSetting` field is `RENEW_WITH_SPECIFIC_TERM`.\n"
},
"renewalSetting": {
"enum": [
"RENEW_WITH_SPECIFIC_TERM",
"RENEW_TO_EVERGREEN"
],
"type": "string",
"description": "Specifies the type of the terms that follow the first term if the subscription is renewed. Only applicable if the type of the first term is `TERMED`.\n\n* `RENEW_WITH_SPECIFIC_TERM` - Each renewal term has a predefined duration. The first entry in `renewalTerms` specifies the duration of the second term of the subscription, the second entry in `renewalTerms` specifies the duration of the third term of the subscription, and so on. The last entry in `renewalTerms` specifies the ultimate duration of each renewal term.\n* `RENEW_TO_EVERGREEN` - The second term of the subscription does not have a predefined duration.\n"
}
},
"description": "Container for the terms and renewal settings of the subscription.\n"
},
"currency": {
"type": "string",
"maxLength": 3,
"description": "The code of currency that is used for this subscription. If the currency is not selected, the default currency from the account will be used.\n\nAll subscriptions in the same order must use the same currency. The currency for a subscription cannot be changed.\n\n**Note**: \n This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currencies</a> feature enabled.\n"
},
"paymentTerm": {
"type": "string",
"description": "The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceSeparately": {
"type": "boolean",
"description": "Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"maxLength": 255,
"description": "The number of the invoice group associated with the subscription.\n\nAfter enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"subscriptionNumber": {
"type": "string",
"maxLength": 100,
"description": "Subscription number of the subscription. For example, A-S00000001.\n\nIf you do not set this field, Zuora will generate the subscription number.\n"
},
"subscribeToRatePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreviewOrderRatePlanOverride"
},
"description": "List of rate plans associated with the subscription.\n"
},
"newSubscriptionOwnerAccount": {
"type": "object",
"required": [
"name",
"currency",
"billCycleDay",
"billToContact"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "Account name.\n"
},
"batch": {
"type": "string",
"description": "Name of the billing batch that the account belongs to. For example, Batch1.\n"
},
"crmId": {
"type": "string",
"maxLength": 100,
"description": "External identifier of the account in a CRM system.\n"
},
"notes": {
"type": "string",
"maxLength": 65535,
"description": "Notes about the account. These notes are only visible to Zuora users.\n"
},
"autoPay": {
"type": "boolean",
"description": "Specifies whether future payments are automatically billed when they are due.\n"
},
"taxInfo": {
"$ref": "#/components/schemas/TaxInfo"
},
"currency": {
"type": "string",
"description": "ISO 3-letter currency code (uppercase). For example, USD.\n"
},
"parentId": {
"type": "string",
"description": "Identifier of the parent customer account for this Account object. Use this field if you have <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy\" target=\"_blank\">Customer Hierarchy</a> enabled."
},
"salesRep": {
"type": "string",
"maxLength": 50,
"description": "The name of the sales representative associated with this account, if applicable.\n"
},
"creditCard": {
"$ref": "#/components/schemas/creditCard"
},
"paymentTerm": {
"type": "string",
"description": "Name of the payment term associated with the account. For example, \"Net 30\". The payment term determines the due dates of invoices.\n"
},
"billCycleDay": {
"type": "integer",
"maximum": 31,
"minimum": 0,
"description": "Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as \"AutoSet\".\n"
},
"customFields": {
"$ref": "#/components/schemas/AccountObjectCustomFields"
},
"accountNumber": {
"type": "string",
"maxLength": 70,
"description": "Account number. For example, A00000001.\n"
},
"billToContact": {
"$ref": "#/components/schemas/BillToContactPostOrder"
},
"paymentMethod": {
"$ref": "#/components/schemas/POSTPaymentMethodRequest"
},
"soldToContact": {
"$ref": "#/components/schemas/SoldToContactPostOrder"
},
"paymentGateway": {
"type": "string",
"maxLength": 40,
"description": "The payment gateway that Zuora uses when processing electronic payments and refunds for the account. If you do not specify this field or if the value of this field is null, Zuora uses your default payment gateway.\n"
},
"allowInvoiceEdit": {
"type": "boolean",
"description": "Indicates if associated invoices can be edited.\nValues are: \n\n* `true`\n* `false` (default)\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "Internal identifier of the invoice template that Zuora uses when generating invoices for the account.\n"
},
"debitMemoTemplateId": {
"type": "string",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThe unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.\n"
},
"purchaseOrderNumber": {
"type": "string",
"maxLength": 100,
"description": "The number of the purchase order associated with this account. Purchase order information generally comes from customers.\n"
},
"creditMemoTemplateId": {
"type": "string",
"description": "**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThe unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.\n"
},
"communicationProfileId": {
"type": "string",
"description": "Internal identifier of the communication profile that Zuora uses when sending notifications to the account's contacts.\n"
},
"customerServiceRepName": {
"type": "string",
"maxLength": 50,
"description": "Name of the account's customer service representative, if applicable.\n"
},
"additionalEmailAddresses": {
"type": "string",
"maxLength": 1200,
"description": "List of additional email addresses to receive emailed invoices. Values should be a comma-separated list of email addresses.\n"
},
"invoiceDeliveryPrefsEmail": {
"type": "boolean",
"description": "Specifies whether to turn on the invoice delivery method 'Email' for the new account. \nValues are: \n\n* `true` (default). Turn on the invoice delivery method 'Email' for the new account.\n* `false`. Turn off the invoice delivery method 'Email' for the new account. \n"
},
"invoiceDeliveryPrefsPrint": {
"type": "boolean",
"description": "Specifies whether to turn on the invoice delivery method 'Print' for the new account.\nValues are: \n\n* `true`. Turn on the invoice delivery method 'Print' for the new account.\n* `false` (default). Turn off the invoice delivery method 'Print' for the new account.\n"
},
"hpmCreditCardPaymentMethodId": {
"type": "string",
"description": "The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account.\n\nIf the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field,\nbut not both.\n\nFor a specified credit card payment method, it is recommended that [the support for stored credential transactions](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Stored_credential_transactions) for this payment method is already enabled.\n"
}
},
"description": "Information about a new account that will own the subscription. Only available if you have enabled the Owner Transfer feature.\n\n**Note:** The Owner Transfer 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\nIf you do not set this field or the `subscriptionOwnerAccountNumber` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `subscriptionOwnerAccountNumber` field.\n"
},
"subscriptionOwnerAccountNumber": {
"type": "string",
"maxLength": 70,
"description": "Account number of an existing account that will own the subscription. For example, A00000001.\n\nIf you do not set this field or the `newSubscriptionOwnerAccount` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `newSubscriptionOwnerAccount` field.\n"
}
},
"description": "Information about an order action of type `CreateSubscription`.\n"
}
PreviewOrderOrderAction
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"CreateSubscription",
"TermsAndConditions",
"AddProduct",
"UpdateProduct",
"RemoveProduct",
"RenewSubscription",
"CancelSubscription",
"OwnerTransfer",
"Suspend",
"Resume",
"ChangePlan"
],
"type": "string",
"description": "Type of order action.\n\nUnless the type of order action is `RenewSubscription`, you must use the corresponding field to provide information about the order action. For example, if the type of order action is `AddProduct`, you must set the `addProduct` field.\n\nZuora returns an error if you set a field that corresponds to a different type of order action. For example, if the type of order action is `AddProduct`, Zuora returns an error if you set the `updateProduct` field.\n\n**Note**: The change plan type of order action is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.\n"
},
"resume": {
"$ref": "#/components/schemas/CreateOrderResume"
},
"suspend": {
"$ref": "#/components/schemas/CreateOrderSuspend"
},
"addProduct": {
"$ref": "#/components/schemas/PreviewOrderRatePlanOverride"
},
"changePlan": {
"$ref": "#/components/schemas/CreateChangePlan"
},
"changeReason": {
"type": "string",
"description": "The change reason set for an order action when an order is created.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrderActionObjectCustomFields"
},
"triggerDates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerDate"
},
"description": "Container for the contract effective, service activation, and customer acceptance dates of the order action. \n\nIf the service activation date is set as a required field in Default Subscription Settings, skipping this field in a `CreateSubscription` order action of your JSON request will result in a `Pending` order and a `Pending Activation` subscription.\n\nIf the customer acceptance date is set as a required field in Default Subscription Settings, skipping this field in a `CreateSubscription` order action of your JSON request will result in a `Pending` order and a `Pending Acceptance` subscription. If the service activation date field is at the same time required and skipped (or set as null), it will be a `Pending Activation` subscription.\n"
},
"ownerTransfer": {
"$ref": "#/components/schemas/OwnerTransfer"
},
"removeProduct": {
"$ref": "#/components/schemas/RemoveProduct"
},
"updateProduct": {
"$ref": "#/components/schemas/PreviewOrderRatePlanUpdate"
},
"renewSubscription": {
"$ref": "#/components/schemas/RenewSubscription"
},
"cancelSubscription": {
"$ref": "#/components/schemas/CancelSubscription"
},
"createSubscription": {
"$ref": "#/components/schemas/PreviewOrderCreateSubscription"
},
"termsAndConditions": {
"$ref": "#/components/schemas/CreateOrderTermsAndConditions"
}
}
}
PreviewOrderPricingUpdate
{
"type": "object",
"properties": {
"discount": {
"$ref": "#/components/schemas/DiscountPricingUpdate"
},
"usageTiered": {
"$ref": "#/components/schemas/UsageTieredPricingUpdate"
},
"usageVolume": {
"$ref": "#/components/schemas/UsageVolumePricingUpdate"
},
"usageFlatFee": {
"$ref": "#/components/schemas/UsageFlatFeePricingUpdate"
},
"usageOverage": {
"$ref": "#/components/schemas/UsageOveragePricingUpdate"
},
"usagePerUnit": {
"$ref": "#/components/schemas/UsagePerUnitPricingUpdate"
},
"chargeModelData": {
"$ref": "#/components/schemas/ChargeModelDataOverride"
},
"recurringTiered": {
"$ref": "#/components/schemas/RecurringTieredPricingUpdate"
},
"recurringVolume": {
"$ref": "#/components/schemas/RecurringVolumePricingUpdate"
},
"recurringFlatFee": {
"$ref": "#/components/schemas/RecurringFlatFeePricingUpdate"
},
"recurringPerUnit": {
"$ref": "#/components/schemas/RecurringPerUnitPricingUpdate"
},
"usageTieredWithOverage": {
"$ref": "#/components/schemas/UsageTieredWithOveragePricingUpdate"
}
},
"x-konfig-properties": {
"discount": {
"description": "Pricing information about a discount charge.\n"
},
"usageTiered": {
"description": "Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.\n"
},
"usageVolume": {
"description": "Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.\n"
},
"usageFlatFee": {
"description": "Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"
},
"usageOverage": {
"description": "Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.\n"
},
"usagePerUnit": {
"description": "Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.\n"
},
"chargeModelData": {
"description": "Container for charge model configuration data.\n\n**Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
},
"recurringTiered": {
"description": "Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n"
},
"recurringVolume": {
"description": "Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n"
},
"recurringFlatFee": {
"description": "Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"
},
"recurringPerUnit": {
"description": "Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n"
},
"usageTieredWithOverage": {
"description": "Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.\n"
}
}
}
PreviewOrderRatePlanOverride
{
"type": "object",
"title": "ratePlan",
"required": [
"productRatePlanId"
],
"properties": {
"uniqueToken": {
"type": "string",
"maxLength": 50,
"description": "Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrdersRatePlanObjectCustomFields"
},
"ratePlanName": {
"type": "string",
"description": "Name of the standalone rate plan.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"chargeOverrides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreviewOrderChargeOverride"
},
"description": "List of charges associated with the rate plan.\n"
},
"productRatePlanId": {
"type": "string",
"description": "Internal identifier of the product rate plan that the rate plan is based on.\n"
},
"isFromExternalCatalog": {
"type": "boolean",
"description": "Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription.\n"
},
"clearingExistingFeatures": {
"type": "boolean",
"description": "Specifies whether all features in the rate plan will be cleared.\n"
},
"subscriptionRatePlanNumber": {
"type": "string",
"maxLength": 50,
"description": "Number of a subscription rate plan for this subscription.\n"
},
"subscriptionProductFeatures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOrderRatePlanFeatureOverride"
},
"description": "List of features associated with the rate plan.\nThe system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:\n* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.\n* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.\n"
}
},
"description": "Information about an order action of type `AddProduct`.\n"
}
PreviewOrderRatePlanUpdate
{
"type": "object",
"title": "updateProduct",
"properties": {
"ratePlanId": {
"type": "string",
"description": "The id of the rate plan to be updated. It can be the latest version or any history version id.\n"
},
"uniqueToken": {
"type": "string",
"description": "A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrdersRatePlanObjectCustomFields"
},
"chargeUpdates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreviewOrderChargeUpdate"
},
"description": "Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.\n\nWhen previewing an `updateProduct` order action, either the `chargeNumber` or `uniqueToken` field is required to specify the charge to update.\n"
},
"specificUpdateDate": {
"type": "string",
"format": "date",
"description": "\nThe date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.\n\nSee [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription.\n"
},
"clearingExistingFeatures": {
"type": "boolean",
"description": "Specifies whether all features in the rate plan will be cleared.\n"
},
"subscriptionRatePlanNumber": {
"type": "string",
"description": "Number of a rate plan for this subscription.\n"
},
"subscriptionProductFeatures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOrderRatePlanFeatureOverride"
},
"description": "List of features associated with the rate plan.\nThe system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:\n* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.\n* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.\n"
}
},
"description": "Information about an order action of type `UpdateProduct`.\n"
}
PreviewOrderTriggerParams
{
"type": "object",
"title": "startDate",
"properties": {
"triggerEvent": {
"enum": [
"ContractEffective",
"ServiceActivation",
"CustomerAcceptance",
"SpecificDate"
],
"type": "string",
"description": "Condition for the charge to become active.\n\nIf the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.\n"
},
"specificTriggerDate": {
"type": "string",
"format": "date",
"description": "Date in YYYY-MM-DD format. Only applicable if the value of the `triggerEvent` field is `SpecificDate`. \n\nWhile this field is applicable, if this field is not set, your `CreateSubscription` order action creates a `Pending` order and a `Pending Acceptance` subscription. If at the same time the service activation date is required and not set, a `Pending Activation` subscription is created.\n"
}
},
"description": "Specifies when a charge becomes active.\n"
}
PreviewResult
{
"type": "object",
"properties": {
"invoices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"taxAmount": {
"type": "number"
},
"targetDate": {
"type": "string",
"format": "date"
},
"invoiceItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceItemPreviewResult"
}
},
"amountWithoutTax": {
"type": "number"
}
}
}
},
"creditMemos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"taxAmount": {
"type": "number"
},
"targetDate": {
"type": "string",
"format": "date"
},
"creditMemoItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceItemPreviewResult"
}
},
"amountWithoutTax": {
"type": "number"
}
}
},
"description": "This field is only available if you have the Invoice Settlement feature enabled."
},
"rampMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderRampMetrics"
},
"description": "**Note**: This field 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 [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information coming October 2020.\n\nThe ramp metrics.\n"
},
"orderMetrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"orderActions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"sequence": {
"type": "string"
},
"orderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItem"
},
"description": "The `orderItems` nested field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
},
"orderMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/orderMetric"
},
"description": "The container for order metrics.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
}
}
}
},
"subscriptionNumber": {
"type": "string"
}
}
},
"description": "**Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects. \n* [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr) \n* [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv) \n* [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb) \n\nIt is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/). \n\nWhereas new customers, and existing customers not currently on [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders), will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported.\n"
},
"chargeMetrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"charges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargePreviewMetrics"
}
},
"subscriptionNumber": {
"type": "string",
"description": "The number of the subscription that has been affected by this order. When creating a subscription, this value will not show if the subscription number was not specified in the request."
}
}
}
},
"orderDeltaMetrics": {
"type": "object",
"properties": {
"orderDeltaMrr": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderDeltaMetric"
}
},
"orderDeltaTcb": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderDeltaTcb"
}
},
"orderDeltaTcv": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderDeltaTcv"
}
}
},
"description": "**Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects. \n* [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr)\n* [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv)\n* [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb)\n\nIt is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/).\n"
}
},
"description": "The result of each type of preview. Returned only when the current request is preview call."
}
PreviewStartDate
{
"type": "object",
"properties": {
"specificDate": {
"type": "string",
"description": "The specific date for the preview start date. Required if `previewStartDatePolicy` is `specificDate`.\n"
},
"previewStartDatePolicy": {
"$ref": "#/components/schemas/PreviewStartDatePolicy"
}
},
"description": "The start date of the preview.\n"
}
PreviewStartDatePolicy
{
"enum": [
"startOfTerm",
"today",
"specificDate"
],
"type": "string",
"description": "The options on how the preview start date is calculated.\n- If you set this field to `startOfTerm`, the preview start date is the start date of the subscription term. \n- If you set this field to `today`, the preview start date is today.\n- If you set this field to `specificDate`, you must specify a specific date in the `specificDate` field. The date must be in the format `yyyy-mm-dd`.\n"
}
PreviewThroughDate
{
"type": "object",
"properties": {
"specificDate": {
"type": "string",
"description": "The specific date for the preview start date. Required if `previewThruDatePolicy` is `specificDate`.\n"
},
"nextBillingPeriods": {
"type": "number",
"description": "The number of billing periods to preview. Required if `previewThruDatePolicy` is `nextBillingPeriods`.\n"
},
"previewThruDatePolicy": {
"$ref": "#/components/schemas/PreviewThruDatePolicy"
}
},
"description": "The preview through date.\n"
}
PreviewThruDatePolicy
{
"enum": [
"nextBillingPeriods",
"endOfTerm",
"specificDate"
],
"type": "string",
"description": "The options on how the preview through date is calculated. \n- If you set this field to `nextBillingPeriods`, you must specify the number of billing periods to preview in the `nextBillingPeriods` field.\n- If you set this field to `endOfTerm`, the preview through date is the end date of the subscription term.\n- If you set this field to `specificDate`, you must specify a specific date in the `specificDate` field. The date must be in the format `yyyy-mm-dd`.\n"
}
PriceChangeParams
{
"type": "object",
"properties": {
"priceChangeOption": {
"enum": [
"NoChange",
"SpecificPercentageValue",
"UseLatestProductCatalogPricing"
],
"type": "string",
"description": "Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n"
},
"priceIncreasePercentage": {
"type": "number",
"minimum": -100,
"description": "Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.\n"
}
}
}
PriceIntervalWithPrice
{
"type": "object",
"title": "priceIntervalWithPrice",
"properties": {
"type": {
"enum": [
"Day",
"Month",
"Infinity"
],
"type": "string",
"description": "Interval type of this pricing.\n"
},
"price": {
"type": "number",
"description": "Price of this interval.\n"
},
"duration": {
"type": "integer",
"minimum": 1,
"description": "Duration period of this interval.\n"
},
"sequence": {
"type": "integer",
"minimum": 1,
"description": "Index of the interval in the interval pricing.\n"
}
}
}
PriceIntervalWithTiers
{
"type": "object",
"title": "priceIntervalWithTiers",
"properties": {
"type": {
"enum": [
"Day",
"Month",
"Infinity"
],
"type": "string",
"description": "Interval type of this pricing.\n"
},
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeTier"
},
"description": "List of cumulative pricing tiers in the charge.\n"
},
"duration": {
"type": "integer",
"minimum": 1,
"description": "Duration period of this interval.\n"
},
"sequence": {
"type": "integer",
"minimum": 1,
"description": "Index of the interval in the interval pricing.\n"
}
}
}
PricingUpdate
{
"type": "object",
"properties": {
"discount": {
"$ref": "#/components/schemas/DiscountPricingUpdate"
},
"usageTiered": {
"$ref": "#/components/schemas/UsageTieredPricingUpdate"
},
"usageVolume": {
"$ref": "#/components/schemas/UsageVolumePricingUpdate"
},
"usageFlatFee": {
"$ref": "#/components/schemas/UsageFlatFeePricingUpdate"
},
"usageOverage": {
"$ref": "#/components/schemas/UsageOveragePricingUpdate"
},
"usagePerUnit": {
"$ref": "#/components/schemas/UsagePerUnitPricingUpdate"
},
"chargeModelData": {
"$ref": "#/components/schemas/ChargeModelDataOverride"
},
"recurringTiered": {
"$ref": "#/components/schemas/RecurringTieredPricingUpdate"
},
"recurringVolume": {
"$ref": "#/components/schemas/RecurringVolumePricingUpdate"
},
"recurringFlatFee": {
"$ref": "#/components/schemas/RecurringFlatFeePricingUpdate"
},
"recurringPerUnit": {
"$ref": "#/components/schemas/RecurringPerUnitPricingUpdate"
},
"recurringDelivery": {
"$ref": "#/components/schemas/RecurringDeliveryPricingUpdate"
},
"usageTieredWithOverage": {
"$ref": "#/components/schemas/UsageTieredWithOveragePricingUpdate"
}
},
"x-konfig-properties": {
"discount": {
"description": "Pricing information about a discount charge.\n"
},
"usageTiered": {
"description": "Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.\n"
},
"usageVolume": {
"description": "Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.\n"
},
"usageFlatFee": {
"description": "Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"
},
"usageOverage": {
"description": "Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.\n"
},
"usagePerUnit": {
"description": "Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.\n"
},
"chargeModelData": {
"description": "Container for charge model configuration data.\n\n**Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
},
"recurringTiered": {
"description": "Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n"
},
"recurringVolume": {
"description": "Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n"
},
"recurringFlatFee": {
"description": "Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"
},
"recurringPerUnit": {
"description": "Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n"
},
"recurringDelivery": {
"description": "Pricing information about a recurring charge that uses the \"delivery\" charge model. This field is only available if you have the Delivery Pricing charge model enabled.\n"
},
"usageTieredWithOverage": {
"description": "Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.\n"
}
}
}
ProcessingOptions
{
"type": "object",
"properties": {
"runBilling": {
"type": "boolean",
"description": "Indicates if the current request needs to generate a billing document. The billing document will be generated against all Order Line Items included in this order."
},
"billingOptions": {
"$ref": "#/components/schemas/BillingOptions"
}
},
"description": "Processing options for generating billing documents."
}
ProductChargeDefinitionObjectCustomFields
{
"type": "object",
"title": "productChargeDefinitionFieldsCustom",
"description": "Container for custom fields of a Product Charge Definition object.\n",
"additionalProperties": {
"description": "Custom fields of the Product Charge Definition object. The name of each custom field has the form of <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
ProductFeatureObjectCustomFields
{
"type": "object",
"title": "productFeatureFieldsCustom",
"description": "Container for custom fields of a Product Feature object.\n",
"additionalProperties": {
"description": "Custom fields of the Product Feature object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
ProductObjectCustomFields
{
"type": "object",
"title": "productFieldsCustom",
"description": "Container for custom fields of a Product object.\n",
"additionalProperties": {
"description": "Custom fields of the Product object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
ProductObjectNSFields
{
"type": "object",
"title": "productFieldsNS",
"properties": {
"ItemType__NS": {
"enum": [
"Inventory",
"Non Inventory",
"Service"
],
"type": "string",
"description": "Type of item that is created in NetSuite for the product. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"SyncDate__NS": {
"type": "string",
"maxLength": 255,
"description": "Date when the product was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationId__NS": {
"type": "string",
"maxLength": 255,
"description": "ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationStatus__NS": {
"type": "string",
"maxLength": 255,
"description": "Status of the product's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
},
"description": "Container for Product fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
ProductRatePlanChargeObjectCustomFields
{
"type": "object",
"title": "productRatePlanChargeFieldsCustom",
"description": "Container for custom fields of a Product Rate Plan Charge object.\n",
"additionalProperties": {
"description": "Custom fields of the Product Rate Plan Charge object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
ProductRatePlanChargeObjectNSFields
{
"type": "object",
"title": "productRatePlanChargeFieldsNS",
"properties": {
"Class__NS": {
"type": "string",
"maxLength": 255,
"description": "Class associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"ItemType__NS": {
"enum": [
"Inventory",
"Non Inventory",
"Service"
],
"type": "string",
"description": "Type of item that is created in NetSuite for the product rate plan charge. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"Location__NS": {
"type": "string",
"maxLength": 255,
"description": "Location associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"SyncDate__NS": {
"type": "string",
"maxLength": 255,
"description": "Date when the product rate plan charge was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"RevRecEnd__NS": {
"enum": [
"Charge Period Start",
"Rev Rec Trigger Date",
"Use NetSuite Rev Rec Template"
],
"type": "string",
"description": "End date condition of the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"Department__NS": {
"type": "string",
"maxLength": 255,
"description": "Department associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"Subsidiary__NS": {
"type": "string",
"maxLength": 255,
"description": "Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"RevRecStart__NS": {
"enum": [
"Charge Period Start",
"Rev Rec Trigger Date",
"Use NetSuite Rev Rec Template"
],
"type": "string",
"description": "Start date condition of the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationId__NS": {
"type": "string",
"maxLength": 255,
"description": "ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IncludeChildren__NS": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Specifies whether the corresponding item in NetSuite is visible under child subsidiaries. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationStatus__NS": {
"type": "string",
"maxLength": 255,
"description": "Status of the product rate plan charge's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"DeferredRevAccount__NS": {
"type": "string",
"maxLength": 255,
"description": "Deferrred revenue account associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"RevRecTemplateType__NS": {
"type": "string",
"maxLength": 255,
"description": "Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"RecognizedRevAccount__NS": {
"type": "string",
"maxLength": 255,
"description": "Recognized revenue account associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
},
"description": "Container for Product Rate Plan Charge fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
ProductRatePlanObjectCustomFields
{
"type": "object",
"title": "productRatePlanFieldsCustom",
"description": "Container for custom fields of a Product Rate Plan object.\n",
"additionalProperties": {
"description": "Custom fields of the Product Rate Plan object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
ProductRatePlanObjectNSFields
{
"type": "object",
"title": "productRatePlanFieldsNS",
"properties": {
"Class__NS": {
"type": "string",
"maxLength": 255,
"description": "Class associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"Price__NS": {
"type": "string",
"maxLength": 255,
"description": "Price associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"ItemType__NS": {
"enum": [
"Inventory",
"Non Inventory",
"Service"
],
"type": "string",
"description": "Type of item that is created in NetSuite for the product rate plan. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"Location__NS": {
"type": "string",
"maxLength": 255,
"description": "Location associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"SyncDate__NS": {
"type": "string",
"maxLength": 255,
"description": "Date when the product rate plan was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"Department__NS": {
"type": "string",
"maxLength": 255,
"description": "Department associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"Subsidiary__NS": {
"type": "string",
"maxLength": 255,
"description": "Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"BillingPeriod__NS": {
"enum": [
"Monthly",
"Quarterly",
"Annual",
"Semi-Annual"
],
"type": "string",
"description": "Billing period associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationId__NS": {
"type": "string",
"maxLength": 255,
"description": "ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IncludeChildren__NS": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Specifies whether the corresponding item in NetSuite is visible under child subsidiaries. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationStatus__NS": {
"type": "string",
"maxLength": 255,
"description": "Status of the product rate plan's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"MultiCurrencyPrice__NS": {
"type": "string",
"maxLength": 255,
"description": "Multi-currency price associated with the corresponding item in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
},
"description": "Container for Product Rate Plan fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
ProxyActioncreateRequest
{
"type": "object",
"example": {
"type": "InvoiceItemAdjustment",
"objects": [
{
"Type": "Credit",
"Amount": 1.2,
"Comment": "this is comments",
"SourceId": "2c93808457d787030157e03248c95144",
"InvoiceId": "2c93808457d787030157e03248c75142",
"SourceType": "InvoiceDetail",
"ReferenceId": "refid-1476935174845",
"InvoiceNumber": "INV00000001",
"AccountingCode": "Accounts Receivable",
"AdjustmentDate": "2016-10-20"
}
]
},
"required": [
"objects",
"type"
],
"properties": {
"type": {
"type": "string",
"description": ""
},
"objects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zObject"
},
"description": ""
}
}
}
ProxyActiondeleteRequest
{
"type": "object",
"example": {
"ids": [
"2c93808457d787030157e031fcd34e19"
],
"type": "ProductRatePlanCharge"
},
"required": [
"type",
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of one or more IDs for the objects you want to delete.\n"
},
"type": {
"type": "string",
"description": "The type of object that you are deleting.\n"
}
}
}
ProxyActionqueryMoreRequest
{
"type": "object",
"example": {
"queryLocator": "2c92c0f9602fb240016049ac7e0b47e7-2000"
},
"required": [
"queryLocator"
],
"properties": {
"conf": {
"type": "object",
"properties": {
"batchSize": {
"type": "integer",
"description": "Defines the batch size of the query result. The range is 1 - 2000 (inclusive). If a value higher than 2000 is submitted, only 2000 results are returned.\n"
}
},
"description": "Configuration of the query result."
},
"queryLocator": {
"type": "string",
"description": "A marker passed to QueryMore to get the next set of results."
}
}
}
ProxyActionqueryMoreResponse
{
"type": "object",
"properties": {
"done": {
"type": "boolean",
"description": "Indicates whether the returned records contain all the query results.\n* If the `queryLocator` field is returned, this field is set to `false`.\n* If no `queryLocator` field is returned, this field is set to `true`.\n"
},
"size": {
"type": "integer",
"format": "int32",
"description": "The number of the returned query results."
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zObject"
},
"description": "A list of queried results."
},
"queryLocator": {
"type": "string",
"description": "A marker passed to QueryMore to get the next set of results."
}
}
}
ProxyActionqueryRequest
{
"type": "object",
"example": {
"queryString": "select AccountId, AccountingCode, AdjustmentDate, AdjustmentNumber, Amount, CancelledById, CancelledDate, Comment, CreatedById, CreatedDate, InvoiceId, InvoiceItemName, InvoiceNumber, ReferenceId, ServiceEndDate, ServiceStartDate, SourceId, SourceType, Status, TransferredToAccounting, Type, UpdatedById, UpdatedDate, ReasonCode from InvoiceItemAdjustment where Id = '2c93808457d787030157e0324aea5158'"
},
"required": [
"queryString"
],
"properties": {
"conf": {
"type": "object",
"properties": {
"batchSize": {
"type": "integer",
"description": "Defines the batch size of the query result. The range is 1 - 2000 (inclusive). If a value higher than 2000 is submitted, only 2000 results are returned.\n"
}
},
"description": "Configuration of the query result."
},
"queryString": {
"type": "string",
"description": "[ZOQL](https://knowledgecenter.zuora.com/DC_Developers/K_Zuora_Object_Query_Language) expression that specifies the object to query, the fields to retrieve, and any filters.\n\n**Note:** When querying one time charges from ProductRatePlanCharge, you need to specify the `ChargeType` value as `One-Time` rather than `OneTime`.\n"
}
}
}
ProxyActionqueryResponse
{
"type": "object",
"properties": {
"done": {
"type": "boolean",
"description": "Indicates whether the returned records contain all the query results.\n* If the `queryLocator` field is returned, this field is set to `false`.\n* If no `queryLocator` field is returned, this field is set to `true`.\n"
},
"size": {
"type": "integer",
"format": "int32",
"description": "The number of the returned query results."
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zObject"
},
"description": "A list of queried results."
},
"queryLocator": {
"type": "string",
"description": "A marker passed to QueryMore to get the next set of results. For more information, see [QueryMore](https://developer.zuora.com/api-references/api/operation/Action_POSTqueryMore/)."
}
}
}
ProxyActionupdateRequest
{
"type": "object",
"example": {
"type": "Account",
"objects": [
{
"Id": "2c93808457d787030157e0321fdf4fab",
"Name": "AC_1476935163869",
"Batch": "Batch1",
"CrmId": "crmid",
"Notes": "this is notes",
"Status": "Active",
"AutoPay": true,
"BillToId": "2c93808457d787030157e03220684fac",
"Currency": "USD",
"SoldToId": "2c93808457d787030157e03220684fac",
"PaymentTerm": "Due Upon Receipt",
"BillCycleDay": 1,
"AccountNumber": "AN_1476935163869",
"InvoiceTemplateId": "2c93808457d787030157e03208864f97",
"DefaultPaymentMethodId": "2c93808457d787030157e03220ec4fad"
}
]
},
"required": [
"objects",
"type"
],
"properties": {
"type": {
"type": "string",
"description": ""
},
"objects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zObject_update"
},
"description": ""
}
}
}
ProxyBadRequestResponse
{
"type": "object",
"properties": {
"Errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"type": "string",
"description": ""
},
"Message": {
"type": "string",
"description": ""
}
}
}
},
"Success": {
"type": "boolean",
"description": ""
}
}
}
ProxyCreateOrModifyDeliverySchedule
{
"type": "object",
"title": "DeliverySchedule",
"properties": {
"friday": {
"type": "boolean",
"description": "The flag to indicate should the delivery happen on Friday\n"
},
"monday": {
"type": "boolean",
"description": "The flag to indicate should the delivery happen on Monday\n"
},
"sunday": {
"type": "boolean",
"description": "The flag to indicate should the delivery happen on Sunday\n"
},
"tuesday": {
"type": "boolean",
"description": "The flag to indicate should the delivery happen on Tuesday\n"
},
"saturday": {
"type": "boolean",
"description": "The flag to indicate should the delivery happen on Saturday\n"
},
"thursday": {
"type": "boolean",
"description": "The flag to indicate should the delivery happen on Thursday\n"
},
"frequency": {
"enum": [
"Weekly"
],
"type": "string",
"description": "The frequency of the delivery. Only supports weekly now\n"
},
"wendesday": {
"type": "boolean",
"description": "The flag to indicate should the delivery happen on Wendesday\n"
}
}
}
ProxyCreateOrModifyProductRatePlanChargeChargeModelConfiguration
{
"type": "object",
"title": "ChargeModelConfiguration",
"properties": {
"ConfigurationItem": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfigurationItem"
},
"description": "An array of Charge Model Configuration Key-Value pairs.\n"
}
},
"description": "Container for charge model configuration data.\n\n**Notes**:\n - This field is only available if you have the Pre-Rated Pricing or Multi-Attribute Pricing charge models enabled. These charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `102` or later. Otherwise, an error occurs with \"Code: INVALID_VALUE\".\n"
}
ProxyCreateOrModifyProductRatePlanChargeChargeModelConfigurationItem
{
"type": "object",
"title": "ConfigurationItem",
"required": [
"Key",
"Value"
],
"properties": {
"Key": {
"type": "string",
"description": "The name of the field that is specified for a specific charge model.\n\nConfiguration keys supported are as follows:\n\n* `formula` (only available if you have the Multi-Attribute Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.)\n* `customFieldPerUnitRate` (only available if you have the Pre-Rated Per Unit Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.)\n* `customFieldTotalAmount` (only available if you have the Pre-Rated Pricing model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.)\n"
},
"Value": {
"type": "string",
"description": "The value of the field that is specified in the `Key` field.\n\nPossible values are follows:\n\n* A valid pricing formula to calculate actual rating amount for each usage record. For example, `usageQuantity()*10`. Use it with Key `formula` when the Multi-Attribute Pricing charge model is used. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n* A name of a usage custom field that carries the per-unit rate for a usage record. For example, `perUnitRate__c`. Use it with Key `customFieldPerUnitRate` when the Pre-Rated Per Unit Pricing charge model is used. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n* A name of a usage custom field that carries the total amount for a usage record. For example, `totalAmount__c`. Use it with Key `customFieldTotalAmount` when the Pre-Rated Pricing model is used. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
}
}
}
ProxyCreateOrModifyProductRatePlanChargeTierData
{
"type": "object",
"title": "productRatePlanChargeTierData",
"properties": {
"ProductRatePlanChargeTier": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Price": {
"type": "number",
"format": "double",
"description": "The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.\n"
},
"Currency": {
"type": "string",
"description": "The code corresponding to the currency for the tier's price.\n"
},
"EndingUnit": {
"type": "number",
"format": "double",
"description": "The end number of a range of units for the tier. Required if the charge model of the product rate plan charge is `Tiered Pricing` or `Tiered with Overage Pricing`.\n"
},
"PriceFormat": {
"enum": [
"Flat Fee",
"Per Unit"
],
"type": "string",
"description": "Indicates if pricing is a flat fee or is per unit. This field is for tiered and volume pricing models only.\n"
},
"StartingUnit": {
"type": "number",
"format": "double",
"description": "The starting number of a range of units for the tier. Required if the charge model of the product rate plan charge is `Tiered Pricing` or `Tiered with Overage Pricing`.\n"
},
"DiscountAmount": {
"type": "number",
"format": "double",
"description": "The specific amount for a fixed discount. Required if the charge model of the product rate plan charge is `Discount-Fixed Amount`.\n"
},
"IsOveragePrice": {
"type": "boolean",
"description": "Indicates if the price is an overage price, which is the price when usage surpasses the last defined tier.\n"
},
"DiscountPercentage": {
"type": "number",
"format": "double",
"description": "The percentage of discount for a percentage discount. Required if the charge model of the product rate plan charge is `Discount-Percentage`.\n"
}
}
},
"description": "Array of product rate plan charge tiers.\n\nYou should specify all relevant fields of all tiers, including pricing information for each currency.\n\nFor each currency, ensure that the tiers appear in ascending order of `StartingUnit`.\n\nFor example:\n\n```\n[\n {\n \"StartingUnit\": \"1\",\n \"EndingUnit\": \"150\",\n \"Currency\": \"USD\",\n \"Price\": 1.95,\n \"PriceFormat\": \"Per Unit\"\n },\n {\n \"StartingUnit\": \"151\",\n \"EndingUnit\": \"300\",\n \"Currency\": \"USD\",\n \"Price\": 1.45,\n \"PriceFormat\": \"Per Unit\"\n },\n {\n \"StartingUnit\": \"1\",\n \"EndingUnit\": \"150\",\n \"Currency\": \"EUR\",\n \"Price\": 1.75,\n \"PriceFormat\": \"Per Unit\"\n },\n {\n \"StartingUnit\": \"151\",\n \"EndingUnit\": \"300\",\n \"Currency\": \"EUR\",\n \"Price\": 1.30,\n \"PriceFormat\": \"Per Unit\"\n }\n]\n```\n"
}
},
"description": "Container for pricing information associated with the product rate plan charge.\n"
}
ProxyCreateOrModifyResponse
{
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": ""
},
"Success": {
"type": "boolean",
"description": ""
}
}
}
ProxyCreateProduct
{
"allOf": [
{
"type": "object",
"required": [
"EffectiveEndDate",
"EffectiveStartDate",
"Name"
],
"properties": {
"SKU": {
"type": "string",
"maxLength": 50,
"description": "The unique SKU for the product.\n\n**Values**: \n - leave null for automatically generated string\n - an alphanumeric string of 50 characters or fewer\n"
},
"Name": {
"type": "string",
"maxLength": 100,
"description": "The name of the product. This information is displayed in the product catalog pages in the web-based UI.\n"
},
"Category": {
"type": "string",
"maxLength": 100,
"description": "Category of the product. Used by Zuora Quotes Guided Product Selector.\n\n**Values**: \n - Base Products\n - Add On Services\n - Miscellaneous Products\n"
},
"Description": {
"type": "string",
"maxLength": 500,
"description": "A description of the product. \n"
},
"ProductNumber": {
"type": "string",
"maxLength": 100,
"description": "The natural key of the product.\n\n**Values**: \n - leave null for automatically generated string\n - an alphanumeric string of 100 characters or fewer\n\n**Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later.\n"
},
"EffectiveEndDate": {
"type": "string",
"format": "date",
"description": "The date when the product expires and can't be subscribed to anymore, in `yyyy-mm-dd` format.\n"
},
"EffectiveStartDate": {
"type": "string",
"format": "date",
"description": "The date when the product becomes available and can be subscribed to, in `yyyy-mm-dd` format.\n"
},
"AllowFeatureChanges": {
"type": "boolean",
"description": "Controls whether to allow your users to add or remove features while creating or amending a subscription.\n\n**Values**: true, false (default)\n"
}
}
},
{
"$ref": "#/components/schemas/ProductObjectNSFields"
},
{
"$ref": "#/components/schemas/ProductObjectCustomFields"
}
],
"example": {
"SKU": "API-SKU1476935173677",
"Name": "P_1476935173677",
"Description": "Create product via API",
"EffectiveEndDate": "2066-10-20",
"EffectiveStartDate": "1966-10-20"
}
}
ProxyCreateProductRatePlan
{
"allOf": [
{
"type": "object",
"required": [
"Name",
"ProductId"
],
"properties": {
"Name": {
"type": "string",
"maxLength": 255,
"description": "The name of the product rate plan. The name doesn't have to be unique in a Product Catalog, but the name has to be unique within a product.\n"
},
"Grade": {
"type": "number",
"description": "The grade that is assigned for the product rate plan. The value of this field must be a positive integer. The greater the value, the higher the grade.\n\nA product rate plan to be added to a Grading catalog group must have one grade. You can specify a grade for a product rate plan in this request or update the product rate plan individually.\n\n**Notes**: \n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `116` or later. Otherwise, an error occurs.\n - This field is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).\n"
},
"ProductId": {
"type": "string",
"maxLength": 32,
"description": "The ID of the product that contains the product rate plan.\n"
},
"Description": {
"type": "string",
"maxLength": 500,
"description": "A description of the product rate plan.\n"
},
"ActiveCurrencies": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of 3-letter currency codes representing active currencies for the product rate plan. Use a comma to separate each currency code.\n\nWhen creating a product rate plan, you can use this field to specify default currency and at most four other active currencies.\n"
},
"EffectiveEndDate": {
"type": "string",
"format": "date",
"maxLength": 29,
"description": "The date when the product rate plan expires and can't be subscribed to, in `yyyy-mm-dd` format.\n"
},
"EffectiveStartDate": {
"type": "string",
"format": "date",
"maxLength": 29,
"description": "The date when the product rate plan becomes available and can be subscribed to, in `yyyy-mm-dd` format.\n"
},
"ProductRatePlanNumber": {
"type": "string",
"maxLength": 100,
"description": "The natural key of the product rate plan.\n\n**Possible values**:\n\n - leave null for automatically generated string\n - an alphanumeric string of 100 characters or fewer\n\n**Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later.\n"
}
}
},
{
"$ref": "#/components/schemas/ProductRatePlanObjectNSFields"
},
{
"$ref": "#/components/schemas/ProductRatePlanObjectCustomFields"
}
],
"example": {
"Name": "ProductRatePlan1476935173957",
"Grade": 3,
"ProductId": "2c93808457d787030157e03246ae5129",
"Description": "Test create product rateplan via API",
"EffectiveEndDate": "2066-10-20",
"EffectiveStartDate": "1966-10-20"
}
}
ProxyCreateProductRatePlanCharge
{
"allOf": [
{
"type": "object",
"required": [
"BillCycleType",
"BillingPeriod",
"ChargeModel",
"ChargeType",
"Name",
"ProductRatePlanChargeTierData",
"ProductRatePlanId",
"TriggerEvent",
"UseDiscountSpecificAccountingCode"
],
"properties": {
"UOM": {
"type": "string",
"nullable": true,
"maxLength": 25,
"description": "Specifies a configured unit to measure usage. \n\n**Note**: You must specify this field when creating the following charge models:\n - Per Unit Pricing\n - Volume Pricing\n - Overage Pricing\n - Tiered Pricing\n - Tiered with Overage Pricing\n"
},
"Name": {
"type": "string",
"maxLength": 100,
"description": "The name of the product rate plan charge.\n"
},
"Formula": {
"type": "string",
"description": "The price lookup formula defined for the product rate plan charge, which is used to identify the correct and relevant charge definition based on the context.\n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing/Price_lookup_in_Attribute-based_Pricing\" target=\"_blank\">Price lookup in Attribute-based Pricing</a>.\n\n**Notes**: \n - This field is available only if the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing\" target=\"_blank\">Attribute-based Pricing</a> feature is enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 138 or higher.\n"
},
"TaxCode": {
"type": "string",
"maxLength": 64,
"description": "Specifies the tax code for taxation rules. Required when the Taxable field is set to `True`.\n\n**Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.\n"
},
"TaxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive",
null
],
"type": "string",
"nullable": true,
"description": "Determines how to define taxation for the charge. Required when the Taxable field is set to `True`.\n\n**Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.\n"
},
"Taxable": {
"type": "boolean",
"description": "Determines whether the charge is taxable. When set to `True`, the TaxMode and TaxCode fields are required when creating or updating th ProductRatePlanCharge object.\n\n**Character limit**: 5\n\n**Values**: `True`, `False`\n\n**Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.\n"
},
"IsPrepaid": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. \n\nIndicates whether this charge is a prepayment (topup) charge or a drawdown charge. \n\n**Values**: `true` or `false`.\n"
},
"ChargeType": {
"enum": [
"OneTime",
"Recurring",
"Usage"
],
"type": "string",
"description": "Specifies the type of charge.\n"
},
"IsRollover": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.\n\nThe value is either \"True\" or \"False\". It determines whether the rollover fields are needed.\n"
},
"IsUnbilled": {
"type": "boolean",
"description": "Specifies how to perform the accounting during revenue recognition. The default value is `False`.\n\n**Values**: `True`, `False`\n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. \n"
},
"PrepaidUom": {
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.\n\nUnit of measurement for a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"RevRecCode": {
"type": "string",
"nullable": true,
"maxLength": 70,
"description": "Associates this product rate plan charge with a specific revenue recognition code.\n"
},
"ChargeModel": {
"enum": [
"Discount-Fixed Amount",
"Discount-Percentage",
"Flat Fee Pricing",
"Per Unit Pricing",
"Overage Pricing",
"Tiered Pricing",
"Tiered with Overage Pricing",
"Volume Pricing",
"Delivery Pricing",
"MultiAttributePricing",
"PreratedPerUnit",
"PreratedPricing`",
"HighWatermarkVolumePricing",
"HighWatermarkTieredPricing"
],
"type": "string",
"description": "Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n\n**Notes:**\n - The `Delivery Pricing` value is available only if you have the Delivery Pricing charge model enabled.\n - The `MultiAttributePricing` value is available only if you have the Multi-Attribute Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. \n - The `PreratedPerUnit` and value is available only if you have the Pre-rated Per Unit Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. \n - The `PreratedPricing` value is available only if you have the Pre-rated Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. \n - The `HighWatermarkVolumePricing`value is available only if you have the High Water Mark Volume Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. \n - The `HighWatermarkTieredPricing` value is available only if you have the High Water Mark Tiered Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
},
"Description": {
"type": "string",
"maxLength": 500,
"description": "A description of the charge.\n"
},
"DrawdownUom": {
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. \n\nUnit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). \n"
},
"MaxQuantity": {
"type": "number",
"format": "double",
"description": "Specifies the maximum number of units for this charge. Use this field and the `MinQuantity` field to create a range of units allowed in a product rate plan charge.\n\n**Character limit**: 16\n\n**Values**: a positive decimal value\n"
},
"MinQuantity": {
"type": "number",
"format": "double",
"description": "Specifies the minimum number of units for this charge. Use this field and the `MaxQuantity` field to create a range of units allowed in a product rate plan charge.\n\n**Character limit**: 16\n\n**Values**: a positive decimal value\n"
},
"ProductLine": {
"type": "string",
"description": "This field is used to maintain the product line for integration with Zuora Revenue. \n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. \n"
},
"RatingGroup": {
"enum": [
"ByBillingPeriod",
"ByUsageStartDate",
"ByUsageRecord",
"ByUsageUpload",
"ByGroupId",
null
],
"type": "string",
"default": "ByBillingPeriod",
"nullable": true,
"description": "Specifies a rating group based on which usage records are rated.\n\nPossible values: \n - `ByBillingPeriod`: The rating is based on all the usages in a billing period. \n - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. \n - `ByUsageRecord`: The rating is based on each usage record.\n - `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`).\n - `ByGroupId`: The rating is based on all the usages in a custom group.\n\n**Notes:** \n - The `ByBillingPeriod` value can be applied for all charge models. \n - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. \n - The `ByGroupId` value is only available if you have the Active Rating feature enabled.\n - Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`.\n"
},
"UpToPeriods": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.\n\n**Character limit**: 5\n\n**Values**: a whole number between 0 and 65535, exclusive\n\n**Notes**:\n - You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`. \n - If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.\n"
},
"BillCycleDay": {
"type": "integer",
"format": "int32",
"description": "Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. The BCD value in the account can override the BCD in this object.\n\n**Character limit**: 2\n\n**Values**: a valid BCD integer, 1 - 31\n"
},
"CreditOption": {
"enum": [
"TimeBased",
"ConsumptionBased",
"FullCreditBack"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. \n\nThe way to calculate credit. See [Credit Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option) for more information. \n"
},
"DrawdownRate": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.\n\nThe [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). See [Fields related to Prepaid with Drawdown](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/ProductRatePlanCharge#Fields_related_to_Prepaid_with_Drawdown) for more information.\n"
},
"ProductClass": {
"type": "string",
"description": "This field is used to maintain the product class for integration with Zuora Revenue. \n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. \n"
},
"TriggerEvent": {
"enum": [
"ContractEffective",
"ServiceActivation",
"CustomerAcceptance"
],
"type": "string",
"description": "Specifies when to start billing the customer for the charge.\n\n**Values**:\n - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.\n - `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access.\n - `CustomerAcceptance` is when the customer accepts the services or products for a subscription.\n"
},
"BillCycleType": {
"enum": [
"DefaultFromCustomer",
"SpecificDayofMonth",
"SubscriptionStartDay",
"ChargeTriggerDay",
"SpecificDayofWeek",
"TermStartDay",
"TermEndDay"
],
"type": "string",
"description": "Specifies how to determine the billing day for the charge. \n\n**Notes**:\n - If you set this field to `SpecificDayofMonth`, you must specify which day of the month as the billing day for the charge in the BillCycleDay field. \n - If you set this field to `SpecificDayofWeek`, you must specify which day of the week as the billing day for the charge in the WeeklyBillCycleDay field. \n - By default, `TermStartDay` and `TermEndDay` are only available for prepayment charges. But you can reach out to Zuora Global Support to request enabling it for non-prepaid recurring charges. Meanwhile, note the following rules applies to these options:\n - The Term End Day option of the Billing Day field must be coupled with the Align to Term End option of the Billing Period Alignment field.\n - For prepaid charges, the Term Start Day option of the Billing Day field must be coupled with the existing Align to Term Start option of the Billing Period Alignment field.\n - For non-prepaid recurring charges: If Billing Day is set to Term Start Day, Billing Period Alignment must be Align to Term Start; If Billing Day is set to Term End Day, Billing Period Alignment can be set to other values.\n"
},
"BillingPeriod": {
"enum": [
"Month",
"Quarter",
"Annual",
"Semi-Annual",
"Specific Months",
"Subscription Term",
"Week",
"Specific Weeks",
"Specific Days"
],
"type": "string",
"description": "The billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD).\n\n**Notes**:\n - Specify the number of months or weeks in the SpecificBillingPeriod field if you set this field to `Specific Months` or `Specific Weeks`.\n - The `Subscription Term` value is in **Limited Availability**.\n"
},
"BillingTiming": {
"enum": [
"In Advance",
"In Arrears"
],
"type": "string",
"description": "The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types.\n\nThis 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"
},
"DiscountLevel": {
"enum": [
"rateplan",
"subscription",
"account"
],
"type": "string",
"description": "Specifies if the discount applies to just the product rate plan, the entire subscription, or to any activity in the account.\n"
},
"IncludedUnits": {
"type": "number",
"format": "double",
"description": "Specifies the number of units in the base set of units.\n\n**Character limit**: 16\n\n**Values**: a positive decimal value\n"
},
"ListPriceBase": {
"enum": [
"Per Billing Period",
"Per Month",
"Per Week",
"Per Year",
"Per Specific Months"
],
"type": "string",
"description": "The list price base for the product rate plan charge.\n"
},
"ProductFamily": {
"type": "string",
"description": "This field is used to maintain the product family for integration with Zuora Revenue. \n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. \n"
},
"RolloverApply": {
"enum": [
"ApplyFirst",
"ApplyLast"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.\n\nThis field defines the priority of rollover, which is either first or last.\n"
},
"AccountingCode": {
"type": "string",
"maxLength": 100,
"description": "The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes.\n"
},
"ChargeFunction": {
"enum": [
"Standard",
"Prepayment",
"CommitmentTrueUp",
"Drawdown",
"CreditCommitment",
"DrawdownAndCreditCommitment"
],
"type": "string",
"description": "**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage\" target=\"_blank\">Unbilled Usage</a> feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to `141` or higher. Otherwise, an error occurs.\n\nThis field defines what type of charge it is in Advanced Consumption Billing:\n* Standard: Normal charge with no Prepayment or Commitment or Drawdown.\n* Prepayment: For recurring charges. Unit or currency based prepaid charge.\n* CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge.\n* Drawdown: For usage charges. Drawdown from prepaid funds.\n* DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds.\n* CreditCommitment: For usage charges. Credit to minimum commitment funds.\n"
},
"CommitmentType": {
"enum": [
"UNIT",
"CURRENCY"
],
"type": "string",
"description": "**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage\" target=\"_blank\">Unbilled Usage</a> feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to `133` or higher. Otherwise, an error occurs. \n\nThis field defines the type of commitment. A prepaid charge can be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can only be `CURRENCY` type. For topup(recurring or one-time) charges, this field indicates what type of funds are created. \n* If UNIT, it will create a fund with given prepaidUom.\n* If CURRENCY, it will create a fund with the currency amount calculated in list price.\n\nFor drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges.\n"
},
"NumberOfPeriod": {
"type": "integer",
"format": "int64",
"description": "Specifies the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number.\n"
},
"SmoothingModel": {
"enum": [
"RollingWindow",
"Rollover",
null
],
"type": "string",
"nullable": true,
"description": "Specifies the smoothing model for an overage smoothing charge model.\n"
},
"ApplyDiscountTo": {
"enum": [
"ONETIME (1)",
"RECURRING (2)",
"USAGE (4)",
"ONETIMERECURRING (3)",
"ONETIMEUSAGE (5)",
"RECURRINGUSAGE (6)",
"ONETIMERECURRINGUSAGE (7)"
],
"type": "string",
"description": "Specifies the type of charges that you want a specific discount to apply to. All field values are case sensitive and in all-caps.\n"
},
"DefaultQuantity": {
"type": "number",
"format": "double",
"description": "The default quantity of units, such as the number of authors in a hosted wiki service. This field is required if you use a per-unit pricing model. \n\n**Character limit**: 16\n\n**Values**: a valid quantity value. \n\n**Note:** When the `ChargeModel` field is set to `Tiered Pricing` or `Volume Pricing`, if this field is not specified, the value will default to `0`.\n"
},
"PrepaidQuantity": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. \n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number.\n"
},
"ProductCategory": {
"type": "string",
"description": "This field is used to maintain the product category for integration with Zuora Revenue. \n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. \n"
},
"RolloverPeriods": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.\n\nThis field defines the number of rollover periods, it is restricted to 3.\n"
},
"UpToPeriodsType": {
"enum": [
"Billing Periods",
"Days",
"Weeks",
"Months",
"Years",
null
],
"type": "string",
"default": "Billing Periods",
"nullable": true,
"description": "The period type used to define when the charge ends.\n\n**Notes**: \n - You must use this field together with the `UpToPeriods` field to specify the time period.\n - This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`. \n"
},
"DeliverySchedule": {
"$ref": "#/components/schemas/ProxyCreateOrModifyDeliverySchedule"
},
"EndDateCondition": {
"enum": [
"SubscriptionEnd",
"FixedPeriod"
],
"type": "string",
"default": "SubscriptionEnd",
"description": "Defines when the charge ends after the charge trigger date.\n\n**Values**: \n - `SubscriptionEnd`: The charge ends on the subscription end date after a specified period based on the trigger date of the charge. \n - `FixedPeriod`: The charge ends after a specified period based on the trigger date of the charge. If you set this field to `FixedPeriod`, you must specify the length of the period and a period type by defining the `UpToPeriods` and `UpToPeriodsType` fields. \n\n \n**Note**: If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date.\n"
},
"IsStackedDiscount": {
"type": "boolean",
"description": "**Note**: This field is only applicable to the Discount - Percentage charge model.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 130 or higher. Otherwise, an error occurs.\n\nThis field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:\n - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.\n - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.\n\nFor more information, see [Stacked discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).\n"
},
"PriceChangeOption": {
"enum": [
"NoChange",
"SpecificPercentageValue",
"UseLatestProductCatalogPricing"
],
"type": "string",
"default": "NoChange",
"description": "Applies an automatic price change when a termed subscription is renewed.\n"
},
"ProductRatePlanId": {
"type": "string",
"maxLength": 32,
"description": "The ID of the product rate plan associated with this product rate plan charge.\n"
},
"ValidityPeriodType": {
"enum": [
"SUBSCRIPTION_TERM",
"ANNUAL",
"SEMI_ANNUAL",
"QUARTER",
"MONTH"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. \n\nThe period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"WeeklyBillCycleDay": {
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string",
"description": "Specifies which day of the week as the bill cycle day (BCD) for the charge.\n\nThis 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"
},
"PriceIncreaseOption": {
"enum": [
"FromTenantPercentageValue",
"SpecificPercentageValue"
],
"type": "string",
"description": "Applies an automatic price change when a termed subscription is renewed.\n"
},
"IsAllocationEligible": {
"type": "boolean",
"description": "Indicates whether the charge segment is allocation eligible in revenue recognition. The default value is `False`.\n\n**Values**: `True`, `False`\n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. \n"
},
"PrepaidOperationType": {
"enum": [
"topup",
"drawdown"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. \n\nThe type of this charge. It is either a prepayment (topup) charge or a drawdown charge. \n"
},
"PrepaidTotalQuantity": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. \n\nThe total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"RolloverPeriodLength": {
"type": "integer",
"default": null,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 137 or higher. Otherwise, an error occurs.\n\nThe period length of the rollover fund. If this field is set as optional, then you can modify the value. The limit for the value should be 1 which should be lesser than equal to the specified period that is lesser than equal to the validity period's length.\n"
},
"SpecificBillingPeriod": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to `Specific Months` or `Specific Weeks`.\nThe valid value is a positive integer.\n"
},
"SpecificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"nullable": true,
"description": "The number of months for the list price base of the charge. This field is required if you set the value of the `ListPriceBase` field to `Per Specific Months`.\n\n**Notes**: \n - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `129` or later. Otherwise, an error occurs.\n - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.\n"
},
"BillingPeriodAlignment": {
"enum": [
"AlignToCharge",
"AlignToSubscriptionStart",
"AlignToTermStart",
"AlignToTermEnd"
],
"type": "string",
"description": "Aligns charges within the same subscription if multiple charges begin on different dates.\n\n**Note:** The `AlignToTermEnd` value is only available for prepayment charges by default. Reach out to Zuora Global Support to enable it for non-prepaid recurring charges.\n"
},
"DeferredRevenueAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the deferred revenue account for this charge.\n\nThis 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"
},
"LegacyRevenueReporting": {
"type": "boolean",
"description": ""
},
"RevRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate",
null
],
"type": "string",
"nullable": true,
"description": "Specifies when revenue recognition begins.\n"
},
"PriceIncreasePercentage": {
"type": "number",
"format": "double",
"nullable": true,
"description": "Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the value to `SpecificPercentageValue`.\n\n**Character limit**: 16\n\n**Values**: a decimal value between -100 and 100\n"
},
"UsageRecordRatingOption": {
"enum": [
"EndOfBillingPeriod",
"OnDemand",
null
],
"type": "string",
"default": "EndOfBillingPeriod",
"nullable": true,
"description": "Determines how Zuora processes usage records for per-unit usage charges. \n"
},
"ChargeModelConfiguration": {
"$ref": "#/components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfiguration"
},
"OverageCalculationOption": {
"enum": [
"EndOfSmoothingPeriod",
"PerBillingPeriod"
],
"type": "string",
"description": "Determines when to calculate overage charges. If the value of the SmoothingMode field is not specified, the value of this field is ignored.\n\n**Values**: \n - `EndOfSmoothingPeriod`: This option is used by default. The overage is charged at the end of the smoothing period.\n - `PerBillingPeriod`: The overage is charged on-demand rather than waiting until the end of the smoothing period.\n"
},
"RecognizedRevenueAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the recognized revenue account for this charge.\n - Required when the Allow Blank Accounting Code setting is No.\n - Optional when the Allow Blank Accounting Code setting is Yes.\n\n 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"
},
"RevenueRecognitionTiming": {
"enum": [
"Upon Billing Document Posting Date",
"Upon Order Activation Date"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue recognition timing.\n\nPredefined options are listed as enum values in this API Reference. \nOther options might also be avaliable depending on \nthe <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"RevenueAmortizationMethod": {
"enum": [
"Immediate",
"Ratable Using Start And End Dates"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue amortization method.\n\nPredefined options are listed as enum values in this API Reference. \nOther options might also be avaliable depending on \nthe <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"RevenueRecognitionRuleName": {
"enum": [
"Recognize upon invoicing",
"Recognize daily over time"
],
"type": "string",
"description": "Determines when to recognize the revenue for this charge.\n"
},
"ProductRatePlanChargeNumber": {
"type": "string",
"maxLength": 100,
"description": "The natural key of the product rate plan charge.\n\n**Values**:\n\n - leave null for automatically generated string\n - an alphanumeric string of 100 characters or fewer\n\n**Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later.\n"
},
"ApplyToBillingPeriodPartially": {
"type": "boolean",
"description": "Allow the discount duration to be aligned with the billing period partially.\n\n**Note**: You must enable the [Enhanced Discount](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.\n"
},
"ProductRatePlanChargeTierData": {
"$ref": "#/components/schemas/ProxyCreateOrModifyProductRatePlanChargeTierData"
},
"OverageUnusedUnitsCreditOption": {
"enum": [
"NoCredit",
"CreditBySpecificRate",
null
],
"type": "string",
"nullable": true,
"description": "Determines whether to credit the customer with unused units of usage.\n"
},
"UseTenantDefaultForPriceChange": {
"type": "boolean",
"description": "Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal. \n\n**Character limit**: 5\n\n**Values**: `true`, `false`\n"
},
"UseDiscountSpecificAccountingCode": {
"type": "boolean",
"nullable": true,
"description": "Determines whether to define a new accounting code for the new discount charge.\n\n**Character limit**: 5\n\n**Values**: `True`, `False`\n"
},
"ExcludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Notes**: \n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.\n - This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
},
"ExcludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude the related rate plan charges and order line items from revenue accounting.\n\n**Notes**: \n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.\n - This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/ProductRatePlanChargeObjectNSFields"
},
{
"$ref": "#/components/schemas/ProductRatePlanChargeObjectCustomFields"
}
],
"example": {
"UOM": "each",
"Name": "Recurring flat fee",
"ChargeType": "Recurring",
"ChargeModel": "Volume Pricing",
"TriggerEvent": "ContractEffective",
"BillCycleType": "DefaultFromCustomer",
"BillingPeriod": "Month",
"AccountingCode": "Deferred Revenue",
"ProductRatePlanId": "2c92c0f8628e007901628f1dc06a453d",
"DeferredRevenueAccount": "Deferred Revenue",
"RecognizedRevenueAccount": "Accounts Receivable",
"ProductRatePlanChargeTierData": {
"ProductRatePlanChargeTier": [
{
"Price": 10,
"Currency": "USD"
}
]
},
"UseDiscountSpecificAccountingCode": false
}
}
ProxyCreateTaxationItem
{
"allOf": [
{
"type": "object",
"required": [
"InvoiceItemId",
"Jurisdiction",
"Name",
"TaxAmount",
"TaxRate",
"TaxDate",
"TaxRateType"
],
"properties": {
"Name": {
"type": "string",
"description": " The name of the tax rate, such as sales tax or GST. This name is displayed on invoices.\n**Character limit**: 128 **Values**: a string of 128 characters or fewer "
},
"TaxCode": {
"type": "string",
"description": " The tax code identifies which tax rules and tax rates to apply to a specific charge.\n**Character limit**: 32 **Values**: a string of 32 characters or fewer "
},
"TaxDate": {
"type": "string",
"format": "date",
"description": " The date that the tax is applied to the charge, in `yyyy-mm-dd` format.\n**Character limit**: 29 "
},
"TaxRate": {
"type": "number",
"format": "double",
"description": " The tax rate applied to the charge.\n**Character limit**: 16 **Values**: a valid decimal value "
},
"TaxAmount": {
"type": "number",
"format": "double",
"description": " The amount of the tax applied to the charge.\n**Character limit**: 16 **Values**: a decimal value "
},
"TaxRateType": {
"type": "string",
"description": " The type of the tax rate applied to the charge.\n**Character limit**: 10 **Values**: `Percentage`, `FlatFee` "
},
"ExemptAmount": {
"type": "number",
"format": "double",
"description": " The calculated tax amount excluded due to the exemption.\n**Character limit**: 16 **Values**: a decimal value "
},
"Jurisdiction": {
"type": "string",
"description": " The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n**Character limit**: 32 **Values**: a string of 32 characterrs or fewer "
},
"LocationCode": {
"type": "string",
"description": " The identifier for the location based on the value of the `TaxCode` field.\n**Character limit**: 32 **Values**: automatically generated "
},
"InvoiceItemId": {
"type": "string",
"description": " The ID of the specific invoice item that the taxation information applies to.\n**Character limit**: 32 **Values**: a valid invoice item ID "
},
"AccountingCode": {
"type": "string",
"description": " The Chart of Accounts "
},
"TaxCodeDescription": {
"type": "string",
"description": " The description for the tax code.\n**Character limit**: 255 **Values**: a string of 255 characters or fewer "
},
"TaxRateDescription": {
"type": "string",
"description": " The description of the tax rate.\n**Character limit**: 255 **Values**: a string of 255 characters or fewer "
}
}
},
{
"$ref": "#/components/schemas/TaxationItemObjectCustomFields"
}
],
"example": {
"Name": "test",
"TaxCode": "taxcode",
"TaxDate": "2016-10-20",
"TaxMode": "TaxExclusive",
"TaxRate": 3,
"TaxAmount": 3,
"TaxRateType": "FlatFee",
"ExemptAmount": 50,
"Jurisdiction": "test",
"LocationCode": "code - 001",
"InvoiceItemId": "2c93808457d787030157e0306cd43a88",
"AccountingCode": "Usage Revenue",
"TaxCodeDescription": "description",
"TaxRateDescription": "test"
}
}
ProxyCreateUsage
{
"allOf": [
{
"type": "object",
"required": [
"Quantity",
"StartDateTime",
"UOM"
],
"properties": {
"UOM": {
"type": "string",
"description": "Specifies the units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**. **Character limit**: **Values**: a valid unit of measure \n"
},
"ChargeId": {
"type": "string",
"description": " The OrginalId of the rate plan charge related to the usage record, e.g., `2c9081a03c63c94c013c6873357a0117` **Character limit**: 32 **Values**: a valid rate plan charge OriginalID. "
},
"Quantity": {
"type": "number",
"format": "double",
"description": "Indicates the number of units used.\n\n**Character limit**: 16 \n\n**Values**: A valid decimal amount. It could be a negative amount. Negative quantity usage records are used to adjust the previously uploaded usage records. \n"
},
"AccountId": {
"type": "string",
"description": " The ID of the account associated with the usage data. This field is only required if no value is specified for the `AccountNumber` field.\n**Character limit**: 32 **Values**: a valid account ID. "
},
"UniqueKey": {
"type": "string",
"description": "The unique external reference of the usage record. See [Upload usage record with unique key](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage#Upload_usage_record_with_unique_key) for information on how to use this field. **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `114` or later.\n"
},
"Description": {
"type": "string",
"maxLength": 200,
"description": "A description of the usage record.\n"
},
"EndDateTime": {
"type": "string",
"format": "date-time",
"description": " The end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation.\n**Character limit**: 29 **Values**: a valid date and time value. "
},
"ChargeNumber": {
"type": "string",
"maxLength": 50,
"description": "A unique number for the rate plan charge related to the usage record. For example, C-00000007.\n"
},
"AccountNumber": {
"type": "string",
"description": " The number of the account associated with the usage data. This field is only required if no value is specified for the `AccountId` field.\n**Character limit**: 50 **Values**: a valid account number. "
},
"StartDateTime": {
"type": "string",
"format": "date-time",
"description": " The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the `EndDateTime`, the `StartDateTime` field does affect usage calculation.\n**Character limit**: 29 **Values**: a valid date and time value "
},
"SubscriptionId": {
"type": "string",
"maxLength": 32,
"description": "The original ID of the subscription that contains the fees related to the usage data. \n\nThe ID of a subscription might change when you create amendments to the subscription. It is good practice to use the unique subscription number that you can specify in the `SubscriptionNumber` field.\n"
},
"SubscriptionNumber": {
"type": "string",
"maxLength": 100,
"description": "The unique identifier number of the subscription that contains the fees related to the usage data.\n\nIt is good practice to use this field when creating usage records.\n"
}
}
},
{
"$ref": "#/components/schemas/UsageObjectCustomFields"
}
],
"example": {
"UOM": "Each",
"Quantity": 9,
"AccountId": "2c92c0f956bc8fb40156d502fc3718b1",
"UniqueKey": "Test001",
"Description": "test",
"ChargeNumber": "C-00000229",
"StartDateTime": "2017-12-01T16:41:36.000+01:00",
"SubscriptionNumber": "A-S00000100"
}
}
ProxyDeleteResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": ""
},
"success": {
"type": "boolean",
"description": ""
}
}
}
ProxyGetImport
{
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "Object identifier."
},
"Md5": {
"type": "string",
"description": " A check to validate the import file's integrity.\n\n**Character limit:** 32\n\n**System-generated:** no\n\n**Values**: a string of 32 characters or fewer "
},
"Name": {
"type": "string",
"description": " A descriptive name for the import.\n\n**Character limit:** 100\n\n**Values:** one of the following:\n\n- a string of 100 characters or fewer\n- if NULL default is: `import <ImportType_value>`\n"
},
"Status": {
"type": "string",
"description": "The status of the import process.\n\n**Values**: automatically generated using one of the following values:\n\n- Pending\n- Processing\n- Completed\n- Failed\n"
},
"ImportType": {
"type": "string",
"description": " The type of item imported.\n\n**Character limit**: 7\n\n**Values**: Usage "
},
"TotalCount": {
"type": "integer",
"format": "int32",
"description": " The number of records in the import file.\n\n**Character limit**:\n\n**Values**: automatically generated "
},
"CreatedById": {
"type": "string",
"description": " The user ID of the person who created the import.\n\n**Character limit**: 32\n\n**Values**: automatically generated "
},
"CreatedDate": {
"type": "string",
"format": "date-time",
"description": " The date when the import was created.\n\n**Character limit**: 29\n\n**Values**: automatically generated "
},
"UpdatedById": {
"type": "string",
"description": " The ID of the user who last updated the import.\n\n**Character limit**: 32\n\n**Values**: automatically generated "
},
"UpdatedDate": {
"type": "string",
"format": "date-time",
"description": " The date when the import was last updated.\n**Character limit**: 29 **Values**: automatically generated "
},
"StatusReason": {
"type": "string",
"description": " The reason for the system-generated status. Use this information if the import fails.\n\n**Character limit**: 2000\n\n**Values**: automatically generated error message "
},
"ImportedCount": {
"type": "integer",
"format": "int32",
"description": "The number of records successfully imported.\n\n**Values**: automatically generated "
},
"ResultResourceUrl": {
"type": "string",
"description": " The URL for the import result file, which is a zipped CSV file.\n\n**Values**: automatic dynamically-generated URL "
},
"OriginalResourceUrl": {
"type": "string",
"description": " The URL for your import file, which contains your records for upload. When you upload the file, Zuora assigns it to this address.\n\n**Values:** automatic dynamically-generated URL "
}
}
}
ProxyGetPaymentMethodSnapshot
{
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "Object identifier."
},
"City": {
"type": "string",
"description": "The city of the customer's address. Applicable to debit payment methods."
},
"IBAN": {
"type": "string",
"description": "The International Bank Account Number. Only applicable to direct debit payment methods."
},
"Name": {
"type": "string",
"description": "The name of the payment method."
},
"Type": {
"enum": [
"ACH",
"ApplePay",
"BankTransfer",
"Cash",
"Check",
"CreditCard",
"CreditCardReferenceTransaction",
"DebitCard",
"Other",
"PayPal",
"WireTransfer"
],
"type": "string",
"description": "The type of payment method."
},
"Email": {
"type": "string",
"description": "An email address for the payment method in addition to the bill to contact email address."
},
"Phone": {
"type": "string",
"description": "The phone number that the account holder registered with the bank. This field is used for credit card validation when passing to a gateway."
},
"State": {
"type": "string",
"description": "The state of the customer's address. Only applicable to direct debit payment methods."
},
"Country": {
"type": "string",
"description": "The two-letter country code of the customer's address. Applicable to direct debit payment methods."
},
"TokenId": {
"type": "string",
"description": "A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. Applicable to CC Reference Transaction payment methods."
},
"BankCity": {
"type": "string",
"description": "The city of the direct debit bank."
},
"BankCode": {
"type": "string",
"description": "The sort code or number that identifies the bank. This is also known as the sort code."
},
"BankName": {
"type": "string",
"description": "The name of the direct debit bank."
},
"LastName": {
"type": "string",
"description": "The customer's last name. Only applicable to direct debit payment methods."
},
"AccountId": {
"type": "string",
"description": "The ID of the customer account associated with this payment method."
},
"FirstName": {
"type": "string",
"description": "The customer's first name. Only applicable to direct debit payment methods."
},
"IPAddress": {
"type": "string",
"description": "The IP address of the user when the payment method was created or updated."
},
"IsCompany": {
"type": "boolean",
"description": "Whether the customer account is a company.\n"
},
"MandateID": {
"type": "string",
"description": "The ID of the mandate. A mandate is a signed authorization for UK and NL customers. Only applicable to direct debit payment methods."
},
"AchAbaCode": {
"type": "string",
"description": "The nine-digit routing number or ABA number used by banks. Applicable to ACH payment methods."
},
"PaypalBaid": {
"type": "string",
"description": "The PayPal billing agreement ID, which is a contract between two PayPal accounts."
},
"PaypalType": {
"enum": [
"ExpressCheckout",
"AdaptivePayments"
],
"type": "string",
"description": "Specifies the PayPal gateway: PayFlow Pro (Express Checkout) or Adaptive Payments."
},
"PostalCode": {
"type": "string",
"description": "The zip code of the customer's address. Only applicable to direct debit payment methods."
},
"StreetName": {
"type": "string",
"description": "The street name of the customer's address. Only applicable to direct debit payment methods."
},
"AchBankName": {
"type": "string",
"description": "The name of the bank where the ACH payment account is held."
},
"CompanyName": {
"type": "string",
"description": "The name of the company.\n"
},
"PaypalEmail": {
"type": "string",
"description": "The email address associated with the account holder's PayPal account or of the PayPal account of the person paying for the service."
},
"StreetNumber": {
"type": "string",
"description": "The street number of the customer's address. Only applicable to direct debit payment methods."
},
"SecondTokenId": {
"type": "string",
"description": "A gateway unique identifier that replaces sensitive payment method data. Applicable to CC Reference Transaction payment methods."
},
"AchAccountName": {
"type": "string",
"description": "The name of the account holder, which can be either a person or a company. Applicable to ACH payment methods."
},
"AchAccountType": {
"enum": [
"BusinessChecking",
"Checking",
"Saving"
],
"type": "string",
"description": "The type of bank account associated with the ACH payment."
},
"BankBranchCode": {
"type": "string",
"description": "The branch code of the bank used for direct debit."
},
"BankCheckDigit": {
"type": "string",
"description": "The check digit in the international bank account number, which confirms the validity of the account. Applicable to direct debit payment methods."
},
"BankPostalCode": {
"type": "string",
"description": "The zip code or postal code of the direct debit bank."
},
"BankStreetName": {
"type": "string",
"description": "The name of the street of the direct debit bank."
},
"CreditCardCity": {
"type": "string",
"description": "The city of the card holder's address. Applicable to credit card and direct debit payment methods."
},
"CreditCardType": {
"enum": [
"AmericanExpress",
"Discover",
"MasterCard",
"Visa"
],
"type": "string",
"description": "The type of credit card or debit card."
},
"IdentityNumber": {
"type": "string",
"description": "The unique identity number of the customer account. \n"
},
"CreditCardState": {
"type": "string",
"description": "The billing address's state. Applicable if `CreditCardCountry` is either Canada or the US."
},
"DeviceSessionId": {
"type": "string",
"description": "The session ID of the user when the `PaymentMethod` was created or updated."
},
"ExistingMandate": {
"enum": [
"Yes",
"No"
],
"type": "string",
"description": "Indicates if the customer has an existing mandate or a new mandate. Only applicable to direct debit payment methods."
},
"MandateReceived": {
"type": "string",
"description": "Indicates if the mandate was received. A mandate is a signed authorization for UK and NL customers. Only applicable to direct debit payment methods."
},
"PaymentMethodId": {
"type": "string",
"description": "Object identifier of the payment method."
},
"BankStreetNumber": {
"type": "string",
"description": "The number of the direct debit bank."
},
"BankTransferType": {
"enum": [
"AutomatischIncasso",
"LastschriftDE",
"LastschriftAT",
"DemandeDePrelevement",
"DirectDebitUK",
"Domicil",
"LastschriftCH",
"RID",
"OrdenDeDomiciliacion",
"Autogiro",
"Betalingsservice"
],
"type": "string",
"description": "Specifies the type of direct debit transfer. The value of this field is dependent on the country of the user.\n\nPossible Values: \n\n\n* `AutomatischIncasso` (NL)\n\n* `LastschriftDE` (Germany)\n\n* `LastschriftAT` (Austria)\n\n* `DemandeDePrelevement` (FR)\n\n* `DirectDebitUK` (UK)\n\n* `Domicil` (Belgium)\n\n* `LastschriftCH` (CH)\n\n* `RID` (Italy)\n\n* `OrdenDeDomiciliacion` (Spain)\n* `Autogiro` (Sweden)\n* `Betalingsservice` (Denmark)\n"
},
"CreditCardCountry": {
"type": "string",
"description": "The country of the card holder's address."
},
"MandateUpdateDate": {
"type": "string",
"format": "date",
"description": "The date when the mandate was last updated, in `yyyy-mm-dd` format. A mandate is a signed authorization for UK and NL customers. Only applicable to direct debit payment methods."
},
"CreditCardAddress1": {
"type": "string",
"description": "The first line of the card holder's address, which is often a street address or business name. Applicable to credit card and direct debit payment methods."
},
"CreditCardAddress2": {
"type": "string",
"description": "The second line of the card holder's address. Applicable to credit card and direct debit payment methods."
},
"PaymentRetryWindow": {
"type": "integer",
"description": "The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours."
},
"MandateCreationDate": {
"type": "string",
"format": "date",
"description": "The date when the mandate was created, in `yyyy-mm-dd` format. A mandate is a signed authorization for UK and NL customers. Only applicable to direct debit payment methods."
},
"PaymentMethodStatus": {
"enum": [
"Active",
"Closed"
],
"type": "string",
"description": "Specifies the status of the payment method."
},
"UseDefaultRetryRule": {
"type": "boolean",
"description": "Determines whether to use the default retry rules configured in the Zuora Payments settings."
},
"AchAccountNumberMask": {
"type": "string",
"description": "This is a masked displayable version of the ACH account number, used for security purposes. For example: `XXXXXXXXX54321`."
},
"CreditCardHolderName": {
"type": "string",
"description": "The full name of the card holder. Applicable to credit card and direct debit payment methods."
},
"CreditCardMaskNumber": {
"type": "string",
"description": "A masked version of the credit or debit card number."
},
"CreditCardPostalCode": {
"type": "string",
"description": "The billing address's zip code."
},
"PaypalPreapprovalKey": {
"type": "string",
"description": "PayPal's Adaptive Payments API key."
},
"LastTransactionStatus": {
"type": "string",
"description": "The status of the most recent transaction."
},
"NumConsecutiveFailures": {
"type": "integer",
"format": "int32",
"description": "The number of consecutive failed payment for the payment method."
},
"BankTransferAccountName": {
"type": "string",
"description": "The name on the direct debit bank account."
},
"BankTransferAccountType": {
"type": "string",
"description": "The type of the customer's bank account. Applicable to direct debit payment methods."
},
"LastTransactionDateTime": {
"type": "string",
"format": "date-time",
"description": "The date of the most recent transaction."
},
"BankIdentificationNumber": {
"type": "string",
"description": "The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method."
},
"CreditCardExpirationYear": {
"type": "integer",
"format": "int32",
"description": "The expiration month of the credit card or debit card. Applicable to credit card and direct debit payment methods."
},
"CreditCardExpirationMonth": {
"type": "integer",
"format": "int32",
"description": "The expiration month of the credit card or debit card. Applicable to credit card and direct debit payment methods."
},
"BusinessIdentificationCode": {
"type": "string",
"description": "The business identification code for Swiss direct payment methods that use the Global Collect payment gateway. Only applicable to direct debit payments in Switzerland with Global Collect."
},
"TotalNumberOfErrorPayments": {
"type": "integer",
"format": "int32",
"description": "The number of error payments that used this payment method."
},
"BankTransferAccountNumberMask": {
"type": "string",
"description": "This is a masked displayable version of the bank account number, used for security purposes. For example: `XXXXXXXXX54321`."
},
"LastFailedSaleTransactionDate": {
"type": "string",
"format": "date-time",
"description": "The date of the last failed attempt to collect payment with this payment method."
},
"MaxConsecutivePaymentFailures": {
"type": "integer",
"description": "The number of allowable consecutive failures Zuora attempts with the payment method before stopping."
},
"TotalNumberOfProcessedPayments": {
"type": "integer",
"format": "int32",
"description": "The number of successful payments that used this payment method."
}
}
}
ProxyGetPaymentMethodTransactionLog
{
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "Object identifier."
},
"Gateway": {
"type": "string",
"description": ""
},
"RequestString": {
"type": "string",
"description": ""
},
"TransactionId": {
"type": "string",
"description": ""
},
"ResponseString": {
"type": "string",
"description": ""
},
"PaymentMethodId": {
"type": "string",
"description": ""
},
"TransactionDate": {
"type": "string",
"format": "date-time",
"description": ""
},
"GatewayReasonCode": {
"type": "string",
"description": ""
},
"PaymentMethodType": {
"type": "string",
"description": ""
},
"GatewayTransactionType": {
"type": "string",
"description": ""
},
"GatewayReasonCodeDescription": {
"type": "string",
"description": ""
}
}
}
ProxyGetPaymentTransactionLog
{
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "The ID of the payment transaction log.\n"
},
"BatchId": {
"type": "string",
"description": "The ID of the batch used to send the transaction if the request was sent in a batch.\n"
},
"Gateway": {
"type": "string",
"description": "The name of the payment gateway used to transact the current payment transaction log.\n"
},
"PaymentId": {
"type": "string",
"description": "The ID of the payment wherein the payment transaction log was recorded. \n"
},
"GatewayState": {
"enum": [
"MarkedForSubmission",
"Submitted",
"Settled",
"NotSubmitted",
"FailedToSettle"
],
"type": "string",
"description": "The state of the transaction at the payment gateway.\n"
},
"RequestString": {
"type": "string",
"description": "The payment transaction request string sent to the payment gateway. \n"
},
"TransactionId": {
"type": "string",
"description": "The transaction ID returned by the payment gateway. This field is used to reconcile payment transactions between the payment gateway and records in Zuora.\n"
},
"ResponseString": {
"type": "string",
"description": "The payment transaction response string returned by the payment gateway. \n"
},
"AVSResponseCode": {
"type": "string",
"description": "The response code returned by the payment gateway referring to the AVS international response of the payment transaction.\n"
},
"CVVResponseCode": {
"type": "string",
"description": "The response code returned by the payment gateway referring to the CVV international response of the payment transaction.\n"
},
"TransactionDate": {
"type": "string",
"format": "date-time",
"description": "The transaction date when the payment was performed. \n"
},
"GatewayReasonCode": {
"type": "string",
"description": "The code returned by the payment gateway for the payment. This code is gateway-dependent.\n"
},
"GatewayTransactionType": {
"enum": [
"Authorization",
"Sale",
"Void",
"Inquiry",
"VoidAuth"
],
"type": "string",
"description": "The type of the transaction, either making a payment, or canceling a payment. \n"
},
"GatewayReasonCodeDescription": {
"type": "string",
"description": "The message returned by the payment gateway for the payment. This message is gateway-dependent. \n"
}
}
}
ProxyGetProduct
{
"allOf": [
{
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "Object identifier."
},
"SKU": {
"type": "string",
"maxLength": 50,
"description": "The unique SKU for the product.\n"
},
"Name": {
"type": "string",
"maxLength": 100,
"description": "The name of the product. This information is displayed in the product catalog pages in the web-based UI.\n"
},
"Category": {
"type": "string",
"maxLength": 100,
"description": "Category of the product. Used by Zuora Quotes Guided Product Selector.\n\n**Values**:\n - Base Products\n - Add On Services\n - Miscellaneous Products\n"
},
"CreatedById": {
"type": "string",
"maxLength": 32,
"description": "The automatically generated ID of the Zuora user who created the `Product` object.\n"
},
"CreatedDate": {
"type": "string",
"format": "date-time",
"description": "The date when the `Product` object was created.\n"
},
"Description": {
"type": "string",
"maxLength": 500,
"description": "A description of the product. \n"
},
"UpdatedById": {
"type": "string",
"maxLength": 32,
"description": "The ID of the last user to update the object.\n"
},
"UpdatedDate": {
"type": "string",
"format": "date-time",
"description": "The date when the object was last updated.\n"
},
"EffectiveEndDate": {
"type": "string",
"format": "date",
"description": "The date when the product expires and can't be subscribed to anymore, in `yyyy-mm-dd` format.\n"
},
"EffectiveStartDate": {
"type": "string",
"format": "date",
"description": "The date when the product becomes available and can be subscribed to, in `yyyy-mm-dd` format.\n"
},
"AllowFeatureChanges": {
"type": "boolean",
"description": "Controls whether to allow your users to add or remove features while creating or amending a subscription.\n\n**Values**: true, false (default)\n"
}
}
},
{
"$ref": "#/components/schemas/ProductObjectNSFields"
},
{
"$ref": "#/components/schemas/ProductObjectCustomFields"
}
]
}
ProxyGetProductRatePlan
{
"allOf": [
{
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "Object identifier."
},
"Name": {
"type": "string",
"maxLength": 255,
"description": "The name of the product rate plan. The name doesn't have to be unique in a Product Catalog, but the name has to be unique within a product.\n"
},
"Grade": {
"type": "number",
"description": "The grade that is assigned for the product rate plan.\n\n**Notes**: \n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `116` or later. Otherwise, an error occurs.\n - This field is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).\n"
},
"ProductId": {
"type": "string",
"maxLength": 32,
"description": "The ID of the product that contains the product rate plan.\n"
},
"CreatedById": {
"type": "string",
"maxLength": 32,
"description": "The automatically generated ID of the Zuora user who created the `ProductRatePlan` object.\n"
},
"CreatedDate": {
"type": "string",
"format": "date-time",
"maxLength": 29,
"description": "The date when the `ProductRatePlan` object was created.\n"
},
"Description": {
"type": "string",
"maxLength": 500,
"description": "A description of the product rate plan.\n"
},
"UpdatedById": {
"type": "string",
"maxLength": 32,
"description": "The automatically generated ID of the last user to update the object.\n"
},
"UpdatedDate": {
"type": "string",
"format": "date-time",
"maxLength": 29,
"description": "The date when the object was last updated.\n"
},
"ActiveCurrencies": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of 3-letter currency codes representing active currencies for the product rate plan. \n\nThis field cannot be queried in conjunction with any other fields except `id` at the same time. \n"
},
"EffectiveEndDate": {
"type": "string",
"format": "date",
"maxLength": 29,
"description": "The date when the product rate plan expires and can't be subscribed to, in `yyyy-mm-dd` format.\n"
},
"EffectiveStartDate": {
"type": "string",
"format": "date",
"maxLength": 29,
"description": "The date when the product rate plan becomes available and can be subscribed to, in `yyyy-mm-dd` format.\n"
}
}
},
{
"$ref": "#/components/schemas/ProductRatePlanObjectNSFields"
},
{
"$ref": "#/components/schemas/ProductRatePlanObjectCustomFields"
}
]
}
ProxyGetProductRatePlanCharge
{
"allOf": [
{
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "Object identifier."
},
"UOM": {
"type": "string",
"nullable": true,
"maxLength": 25,
"description": "Specifies the units to measure usage. \n\n**Note**: You must specify this field when creating the following charge models:\n - Per Unit Pricing\n - Volume Pricin\n - Overage Pricing\n - Tiered Pricing\n - Tiered with Overage Pricing\n"
},
"Name": {
"type": "string",
"maxLength": 100,
"description": "The name of the product rate plan charge.\n"
},
"Formula": {
"type": "string",
"description": "The price lookup formula defined for the product rate plan charge, which is used to identify\nthe correct and relevant charge definition based on the context.\n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing/Price_lookup_in_Attribute-based_Pricing\" target=\"_blank\">Price lookup in Attribute-based Pricing</a>.\n\n\n**Notes**: \n - This field is available only if the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing\" target=\"_blank\">Attribute-based Pricing</a> feature is enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 138 or higher.\n"
},
"TaxCode": {
"type": "string",
"maxLength": 64,
"description": "Specifies the tax code for taxation rules. Required when the Taxable field is set to `True`.\n\n**Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.\n"
},
"TaxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive",
null
],
"type": "string",
"nullable": true,
"description": "Determines how to define taxation for the charge. Required when the Taxable field is set to `True`.\n\n**Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.\n"
},
"Taxable": {
"type": "boolean",
"description": "Determines whether the charge is taxable. When set to `True`, the TaxMode and TaxCode fields are required when creating or updating th ProductRatePlanCharge object.\n\n**Character limit**: 5\n\n**Values**: `True`, `False`\n\n**Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.\n"
},
"ChargeType": {
"enum": [
"OneTime",
"Recurring",
"Usage"
],
"type": "string",
"description": "Specifies the type of charge.\n"
},
"IsUnbilled": {
"type": "boolean",
"description": "Specifies how to perform the accounting during revenue recognition. The default value is `False`.\n\n**Values**: `True`, `False`\n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. \n"
},
"RevRecCode": {
"type": "string",
"nullable": true,
"maxLength": 70,
"description": "Associates this product rate plan charge with a specific revenue recognition code.\n"
},
"ChargeModel": {
"enum": [
"Discount-Fixed Amount",
"Discount-Percentage",
"Flat Fee Pricing",
"Per Unit Pricing",
"Overage Pricing",
"Tiered Pricing",
"Tiered with Overage Pricing",
"Volume Pricing",
"Delivery Pricing",
"MultiAttributePricing",
"PreratedPerUnit",
"PreratedPricing`",
"HighWatermarkVolumePricing",
"HighWatermarkTieredPricing"
],
"type": "string",
"description": "Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n"
},
"CreatedById": {
"type": "string",
"maxLength": 32,
"description": "The automatically generated ID of the Zuora user who created the `ProductRatePlanCharge` object.\n"
},
"CreatedDate": {
"type": "string",
"format": "date-time",
"maxLength": 29,
"description": "The date when the `ProductRatePlanCharge` object was created.\n"
},
"Description": {
"type": "string",
"maxLength": 500,
"description": "A description of the charge.\n"
},
"MaxQuantity": {
"type": "number",
"format": "double",
"description": "Specifies the maximum number of units for this charge. Use this field and the `MinQuantity` field to create a range of units allowed in a product rate plan charge.\n\n**Character limit**: 16\n\n**Values**: a positive decimal value\n"
},
"MinQuantity": {
"type": "number",
"format": "double",
"description": "Specifies the minimum number of units for this charge. Use this field and the `MaxQuantity` field to create a range of units allowed in a product rate plan charge.\n\n**Character limit**: 16\n\n**Values**: a positive decimal value\n"
},
"ProductLine": {
"type": "string",
"description": "This field is used to maintain the product line for integration with Zuora Revenue. \n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled. \n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. \n"
},
"RatingGroup": {
"enum": [
"ByBillingPeriod",
"ByUsageStartDate",
"ByUsageRecord",
"ByUsageUpload",
"ByGroupId",
null
],
"type": "string",
"nullable": true,
"description": "A rating group based on which usage records are rated. Only applicable to Usage charges.\n\nPossible values:\n - `ByBillingPeriod`: The rating is based on all the usages in a billing period.\n - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. \n - `ByUsageRecord`: The rating is based on each usage record.\n - `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`).\n - `ByGroupId`: The rating is based on all the usages in a custom group.\n\nFor more information, see [Usage rating by group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group).\n"
},
"UpToPeriods": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.\n\n**Character limit**: 5\n\n**Values**: a whole number between 0 and 65535, exclusive\n\n**Notes**:\n - You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`. \n - If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.\n"
},
"UpdatedById": {
"type": "string",
"maxLength": 32,
"description": "The ID of the last user to update the object.\n"
},
"UpdatedDate": {
"type": "string",
"format": "date-time",
"maxLength": 29,
"description": "The date when the object was last updated.\n"
},
"BillCycleDay": {
"type": "integer",
"format": "int32",
"description": "Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. The BCD value in the account can override the BCD in this object.\n\n**Character limit**: 2\n\n**Values**: a valid BCD integer, 1 - 31\n"
},
"ProductClass": {
"type": "string",
"description": "This field is used to maintain the product class for integration with Zuora Revenue. \n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled. \n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. \n"
},
"TriggerEvent": {
"enum": [
"ContractEffective",
"ServiceActivation",
"CustomerAcceptance"
],
"type": "string",
"description": "Specifies when to start billing the customer for the charge.\n\n**Values**:\n - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.\n - `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access.\n - `CustomerAcceptance` is when the customer accepts the services or products for a subscription.\n"
},
"BillCycleType": {
"enum": [
"DefaultFromCustomer",
"SpecificDayofMonth",
"SubscriptionStartDay",
"ChargeTriggerDay",
"SpecificDayofWeek",
"TermStartDay",
"TermEndDay"
],
"type": "string",
"description": "Specifies how to determine the billing day for the charge. \n"
},
"BillingPeriod": {
"enum": [
"Month",
"Quarter",
"Annual",
"Semi-Annual",
"Specific Months",
"Subscription Term",
"Week",
"Specific Weeks",
"Specific Days"
],
"type": "string",
"description": "The billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD).\n"
},
"BillingTiming": {
"enum": [
"In Advance",
"In Arrears"
],
"type": "string",
"description": "The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types.\n\nThis 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"
},
"DiscountLevel": {
"enum": [
"rateplan",
"subscription",
"account"
],
"type": "string",
"description": "Specifies if the discount applies to just the product rate plan, the entire subscription, or to any activity in the account.\n"
},
"IncludedUnits": {
"type": "number",
"format": "double",
"description": "Specifies the number of units in the base set of units.\n\n**Character limit**: 16\n\n**Values**: a positive decimal value\n"
},
"ListPriceBase": {
"enum": [
"Per Billing Period",
"Per Month",
"Per Week",
"Per Year",
"Per Specific Months"
],
"type": "string",
"description": "The list price base for the product rate plan charge.\n"
},
"ProductFamily": {
"type": "string",
"description": "This field is used to maintain the product family for integration with Zuora Revenue. \n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.\n"
},
"AccountingCode": {
"type": "string",
"maxLength": 100,
"description": "The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes.\n"
},
"ChargeFunction": {
"enum": [
"Standard",
"Prepayment",
"CommitmentTrueUp",
"Drawdown",
"CreditCommitment",
"DrawdownAndCreditCommitment"
],
"type": "string",
"description": "**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage\" target=\"_blank\">Unbilled Usage</a> feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to `141` or higher. Otherwise, an error occurs.\n\nThis field defines what type of charge it is in Advanced Consumption Billing:\n* Standard: Normal charge with no Prepayment or Commitment or Drawdown.\n* Prepayment: For recurring charges. Unit or currency based prepaid charge.\n* CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge.\n* Drawdown: For usage charges. Drawdown from prepaid funds.\n* DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds.\n* CreditCommitment: For usage charges. Credit to minimum commitment funds.\n"
},
"CommitmentType": {
"enum": [
"UNIT",
"CURRENCY"
],
"type": "string",
"description": "**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage\" target=\"_blank\">Unbilled Usage</a> feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to `133` or higher. Otherwise, an error occurs. \n\nThis field defines the type of commitment. A prepaid charge can be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can only be `CURRENCY` type. For topup(recurring or one-time) charges, this field indicates what type of funds are created. \n* If UNIT, it will create a fund with given prepaidUom.\n* If CURRENCY, it will create a fund with the currency amount calculated in list price.\n \nFor drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges.\n"
},
"NumberOfPeriod": {
"type": "integer",
"format": "int64",
"description": "Specifies the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number.\n"
},
"SmoothingModel": {
"enum": [
"RollingWindow",
"Rollover",
null
],
"type": "string",
"nullable": true,
"description": "Specifies the smoothing model for an overage smoothing charge model.\n"
},
"ApplyDiscountTo": {
"enum": [
"ONETIME (1)",
"RECURRING (2)",
"USAGE (4)",
"ONETIMERECURRING (3)",
"ONETIMEUSAGE (5)",
"RECURRINGUSAGE (6)",
"ONETIMERECURRINGUSAGE (7)"
],
"type": "string",
"description": "Specifies the type of charges that you want a specific discount to apply to. All field values are case sensitive and in all-caps.\n"
},
"DefaultQuantity": {
"type": "number",
"format": "double",
"description": "The default quantity of units, such as the number of authors in a hosted wiki service. This field is required if you use a per-unit pricing model.\n\n**Character limit**: 16\n\n**Values**: a valid quantity value.\n\n**Note**: When `ChargeModel` is `Tiered Pricing` or `Volume Pricing`, if this field is not specified, the value will default to `0`.\n"
},
"ProductCategory": {
"type": "string",
"description": "This field is used to maintain the product category for integration with Zuora Revenue. \n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.\n"
},
"UpToPeriodsType": {
"enum": [
"Billing Periods",
"Days",
"Weeks",
"Months",
"Years",
null
],
"type": "string",
"default": "Billing Periods",
"nullable": true,
"description": "The period type used to define when the charge ends.\n\n**Notes**: \n - You must use this field together with the `UpToPeriods` field to specify the time period.\n - This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`. \n"
},
"EndDateCondition": {
"enum": [
"SubscriptionEnd",
"FixedPeriod"
],
"type": "string",
"default": "SubscriptionEnd",
"description": "Defines when the charge ends after the charge trigger date.\n\n**Values**: \n - `SubscriptionEnd`: The charge ends on the subscription end date after a specified period based on the trigger date of the charge. \n - `FixedPeriod`: The charge ends after a specified period based on the trigger date of the charge. If you set this field to `FixedPeriod`, you must specify the length of the period and a period type by defining the `UpToPeriods` and `UpToPeriodsType` fields. \n\n **Note**: If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date.\n"
},
"PriceChangeOption": {
"enum": [
"NoChange",
"SpecificPercentageValue",
"UseLatestProductCatalogPricing",
null
],
"type": "string",
"default": "NoChange",
"nullable": true,
"description": "Applies an automatic price change when a termed subscription is renewed.\n"
},
"ProductRatePlanId": {
"type": "string",
"maxLength": 32,
"description": "The ID of the product rate plan associated with this product rate plan charge.\n"
},
"WeeklyBillCycleDay": {
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string",
"description": "Specifies which day of the week as the bill cycle day (BCD) for the charge.\n\nThis 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"
},
"IsAllocationEligible": {
"type": "boolean",
"description": "Indicates whether the charge segment is allocation eligible in revenue recognition. The default value is `False`.\n\n**Values**: `True`, `False`\n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.\n"
},
"SpecificBillingPeriod": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to `Specific Months` or `Specific Weeks`.\nThe valid value is a positive integer.\n"
},
"SpecificListPriceBase": {
"type": "integer",
"nullable": true,
"description": "The number of months for the list price base of the charge. The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.\n\n**Notes**: \n - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `129` or later. Otherwise, an error occurs.\n - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.\n"
},
"BillingPeriodAlignment": {
"enum": [
"AlignToCharge",
"AlignToSubscriptionStart",
"AlignToTermStart",
"AlignToTermEnd"
],
"type": "string",
"description": "Aligns charges within the same subscription if multiple charges begin on different dates.\n"
},
"DeferredRevenueAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the deferred revenue account for this charge.\n\nThis 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"
},
"LegacyRevenueReporting": {
"type": "boolean",
"description": ""
},
"RevRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate",
null
],
"type": "string",
"nullable": true,
"description": "Specifies when revenue recognition begins.\n"
},
"PriceIncreasePercentage": {
"type": "number",
"format": "double",
"nullable": true,
"description": "Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the value to `SpecificPercentageValue`.\n\n**Character limit**: 16\n\n**Values**: a decimal value between -100 and 100\n"
},
"OverageCalculationOption": {
"enum": [
"EndOfSmoothingPeriod",
"PerBillingPeriod",
null
],
"type": "string",
"nullable": true,
"description": "Determines when to calculate overage charges. If the value of the SmoothingMode field is not specified, the value of this field is ignored.\n\n**Values**: \n - `EndOfSmoothingPeriod`: This option is used by default. The overage is charged at the end of the smoothing period.\n - `PerBillingPeriod`: The overage is charged on-demand rather than waiting until the end of the smoothing period.\n"
},
"RecognizedRevenueAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the recognized revenue account for this charge.\n - Required when the Allow Blank Accounting Code setting is No.\n - Optional when the Allow Blank Accounting Code setting is Yes.\n\nThis 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"
},
"RevenueRecognitionTiming": {
"enum": [
"Upon Billing Document Posting Date",
"Upon Order Activation Date"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue recognition timing.\n\nPredefined options are listed as enum values in this API Reference. \nOther options might also be avaliable depending on \nthe <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"RevenueAmortizationMethod": {
"enum": [
"Immediate",
"Ratable Using Start And End Dates"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue amortization method.\n\nPredefined options are listed as enum values in this API Reference. \nOther options might also be avaliable depending on \nthe <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"RevenueRecognitionRuleName": {
"enum": [
"Recognize upon invoicing",
"Recognize daily over time"
],
"type": "string",
"description": "Determines when to recognize the revenue for this charge.\n"
},
"ApplyToBillingPeriodPartially": {
"type": "boolean",
"description": "Allow the discount duration to be aligned with the billing period partially.\n\n**Note**: You must enable the [Enhanced Discount](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.\n"
},
"OverageUnusedUnitsCreditOption": {
"enum": [
"NoCredit",
"CreditBySpecificRate",
null
],
"type": "string",
"nullable": true,
"description": "Determines whether to credit the customer with unused units of usage.\n"
},
"UseTenantDefaultForPriceChange": {
"type": "boolean",
"description": "Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal. \n\n**Character limit**: 5\n\n**Values**: `true`, `false`\n"
},
"UseDiscountSpecificAccountingCode": {
"type": "boolean",
"nullable": true,
"description": "Determines whether to define a new accounting code for the new discount charge.\n\n**Character limit**: 5\n\n**Values**: `True`, `False`\n"
},
"ExcludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Notes**: \n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.\n - This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
},
"ExcludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude the related rate plan charges and order line items from revenue accounting.\n\n**Notes**: \n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.\n - This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/ProductRatePlanChargeObjectNSFields"
},
{
"$ref": "#/components/schemas/ProductRatePlanChargeObjectCustomFields"
}
]
}
ProxyGetProductRatePlanChargeTier
{
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "Object identifier."
},
"Tier": {
"type": "integer",
"format": "int32",
"description": "A unique number that identifies the tier that the price applies to.\n\n**Character limit**: 20\n\n**Values**: automatically generated\n"
},
"Price": {
"type": "number",
"format": "double",
"description": "The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.\n\n**Character limit**: 16\n\n**Values**: a valid currency value\n"
},
"Currency": {
"type": "string",
"maxLength": 3,
"description": "The valid code corresponding to the currency for the tier's price.\n"
},
"EndingUnit": {
"type": "number",
"format": "double",
"description": "The end number of a range of units for the tier.\n\n**Character limit**: 16\n\n**Values**: any positive decimal value\n"
},
"CreatedById": {
"type": "string",
"maxLength": 32,
"description": "The ID of the Zuora user who created the ProductRatePlanChargeTier object.\n"
},
"CreatedDate": {
"type": "string",
"format": "date-time",
"maxLength": 29,
"description": "The date when the ProductRatePlanChargeTier object was created.\n"
},
"PriceFormat": {
"type": "string",
"maxLength": 8,
"description": "Indicates if pricing is a flat fee or is per unit. This field is for tiered and volume pricing models only.\n\n**Values**: `FlatFee`, `PerUnit`\n\n**Note:** The values `Flat Fee` and `Per Unit` (with spaces) is valid for create or update calls.\n"
},
"UpdatedById": {
"type": "string",
"maxLength": 32,
"description": "The ID of the user who last updated the product rate plan charge tier.\n"
},
"UpdatedDate": {
"type": "string",
"format": "date-time",
"maxLength": 29,
"description": "The date when the product rate plan charge tier was last updated.\n"
},
"StartingUnit": {
"type": "number",
"format": "double",
"description": "The starting number of a range of units for the tier.\n\n**Character limit**: 16\n\n**Values**: any positive decimal value\n"
}
}
}
ProxyGetUsage
{
"allOf": [
{
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "Object identifier."
},
"UOM": {
"type": "string",
"description": " Specifies the units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**.\n**Character limit**: **Values**: a valid unit of measure "
},
"ChargeId": {
"type": "string",
"description": " The OrginalId of the rate plan charge related to the usage record, e.g., `2c9081a03c63c94c013c6873357a0117` **Character limit**: 32 **Values**: a valid rate plan charge OriginalID "
},
"Quantity": {
"type": "number",
"format": "double",
"description": "Indicates the number of units used.\n\n**Character limit**: 16 \n\n**Values**: A valid decimal amount. It could be a negative amount. Negative quantity usage records are used to adjust the previously uploaded usage records.\n"
},
"AccountId": {
"type": "string",
"description": " The ID of the account associated with the usage data. This field is required if no value is specified for the `AccountNumber` field.\n**Character limit**: 32 **Values**: a valid account ID "
},
"RbeStatus": {
"type": "string",
"description": " Indicates if the rating and billing engine (RBE) processed usage data for an invoice.\n**Character limit**: 9 **Values**: automatically generated to be one of the following values: `Importing`, `Pending`, `Processed` "
},
"SourceType": {
"type": "string",
"description": " Indicates if the usage records were imported from the web-based UI or the API.\n**Character limit**: 6 **Values**: automatically generated to be one of the following values: `API`, `Import` "
},
"CreatedById": {
"type": "string",
"description": " The user ID of the person who uploaded the usage records.\n**Character limit**: 32 **Values**: automatically generated "
},
"CreatedDate": {
"type": "string",
"format": "date-time",
"description": " The date when the usage was generated.\n**Character limit**: 29 **Values**: automatically generated "
},
"Description": {
"type": "string",
"description": "A description of the usage record.\n"
},
"EndDateTime": {
"type": "string",
"format": "date-time",
"description": " The end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation.\n**Character limit**: 29 **Values**: a valid date and time value "
},
"UpdatedById": {
"type": "string",
"description": " The ID of the user who last updated the usage upload.\n**Character limit**: 32 **Values**: automatically generated "
},
"UpdatedDate": {
"type": "string",
"format": "date-time",
"description": " The date when the usage upload was last updated.\n**Character limit**: 29 **Values**: automatically generated "
},
"AccountNumber": {
"type": "string",
"description": " The number of the account associated with the usage data. This field is required if no value is specified for the `AccountId` field.\n**Character limit**: 50 **Values**: a valid account number "
},
"StartDateTime": {
"type": "string",
"format": "date-time",
"description": " The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the `EndDateTime`, the `StartDateTime` field does affect usage calculation.\n**Character limit**: 29 **Values**: a valid date and time value "
},
"SubscriptionId": {
"type": "string",
"description": " The original ID of the subscription that contains the fees related to the usage data.\n**Character limit**: 32 **Values**: a valid subscription ID "
},
"SubscriptionNumber": {
"type": "string",
"description": "The unique identifier number of the subscription that contains the fees related to the usage data.\n"
}
}
},
{
"$ref": "#/components/schemas/UsageObjectCustomFields"
}
]
}
ProxyModifyProduct
{
"allOf": [
{
"type": "object",
"properties": {
"SKU": {
"type": "string",
"maxLength": 50,
"description": "The unique SKU for the product.\n"
},
"Name": {
"type": "string",
"maxLength": 100,
"description": "The name of the product. This information is displayed in the product catalog pages in the web-based UI.\n"
},
"Category": {
"type": "string",
"maxLength": 100,
"description": "Category of the product. Used by Zuora Quotes Guided Product Selector.\n\n**Values**:\n - Base Products\n - Add On Services\n - Miscellaneous Products\n"
},
"Description": {
"type": "string",
"maxLength": 500,
"description": "A description of the product. \n"
},
"ProductNumber": {
"type": "string",
"maxLength": 100,
"description": "The natural key of the product. \n\nFor existing Product objects that are created before this field is introduced, this field will be null. Use this field to specify a value for only these objects. Zuora also provides a tool to help you automatically backfill this field with tenant ID for your existing product catalog. If you want to use this backfill tool, contact [Zuora Global Support](https://support.zuora.com/).\n\n**Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later.\n"
},
"EffectiveEndDate": {
"type": "string",
"format": "date",
"description": "The date when the product expires and can't be subscribed to anymore, in `yyyy-mm-dd` format.\n"
},
"EffectiveStartDate": {
"type": "string",
"format": "date",
"description": "The date when the product becomes available and can be subscribed to, in `yyyy-mm-dd` format.\n"
},
"AllowFeatureChanges": {
"type": "boolean",
"description": "Controls whether to allow your users to add or remove features while creating or amending a subscription.\n\n**Values**: true, false (default)\n"
}
}
},
{
"$ref": "#/components/schemas/ProductObjectNSFields"
},
{
"$ref": "#/components/schemas/ProductObjectCustomFields"
}
],
"example": {
"Id": "2c93808457d787030157e02e7be22210",
"SKU": "API-SKU1476934925293",
"Name": "P_1476934925293_new",
"Description": "Create product via API_new",
"EffectiveEndDate": "2066-10-20",
"EffectiveStartDate": "1966-10-20"
}
}
ProxyModifyProductRatePlan
{
"allOf": [
{
"type": "object",
"properties": {
"Name": {
"type": "string",
"maxLength": 255,
"description": "The name of the product rate plan. The name doesn't have to be unique in a Product Catalog, but the name has to be unique within a product.\n"
},
"Grade": {
"type": "number",
"description": "The grade that is assigned for the product rate plan. The value of this field must be a positive integer. The greater the value, the higher the grade.\n\nA product rate plan to be added to a Grading catalog group must have one grade. You can specify a grade for a product rate plan in this request or update the product rate plan individually.\n\n**Notes**: \n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `116` or later. Otherwise, an error occurs.\n - This field is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).\n"
},
"ProductId": {
"type": "string",
"maxLength": 32,
"description": "The ID of the product that contains the product rate plan.\n"
},
"Description": {
"type": "string",
"maxLength": 500,
"description": "A description of the product rate plan.\n"
},
"ActiveCurrencies": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of 3-letter currency codes representing active currencies for the product rate plan. Use a comma to separate each currency code.\n\nIf the request body contains this field, the value of this field must contain the desired list of active currencies. The new list can never have more than four differences from the existing list.\n\nThis field cannot be used to modify the status of more than four currencies in a single request. For example, in a single request, you can only activate four currencies, or deactivate four currencies, or activate two and deactivate two. Making more than four changes to currencies always requires more than one call.\n\nWhen specifying this field in the update request, you must provide the full list of active currencies you want, not just incremental changes. For each active currency update, provide the following currencies in the list:\n\nCurrent active currencies + at most four changes (additions or deletions)\n"
},
"EffectiveEndDate": {
"type": "string",
"format": "date",
"maxLength": 29,
"description": "The date when the product rate plan expires and can't be subscribed to, in `yyyy-mm-dd` format.\n"
},
"EffectiveStartDate": {
"type": "string",
"format": "date",
"maxLength": 29,
"description": "The date when the product rate plan becomes available and can be subscribed to, in `yyyy-mm-dd` format.\n"
},
"ProductRatePlanNumber": {
"type": "string",
"maxLength": 100,
"description": "The natural key of the product rate plan. \n\nFor existing Product Rate Plan objects that are created before this field is introduced, this field will be null. Use this field to specify a value for only these objects. Zuora also provides a tool to help you automatically backfill this field with tenant ID for your existing product catalog. If you want to use this backfill tool, contact [Zuora Global Support](https://support.zuora.com/).\n\n**Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later.\n"
}
}
},
{
"$ref": "#/components/schemas/ProductRatePlanObjectNSFields"
},
{
"$ref": "#/components/schemas/ProductRatePlanObjectCustomFields"
}
],
"example": {
"Id": "2c93808457d787030157e02da0d91852",
"Name": "ProductRatePlan1476934869186_new"
}
}
ProxyModifyProductRatePlanCharge
{
"allOf": [
{
"type": "object",
"required": [
"BillCycleType",
"BillingPeriod",
"ChargeModel",
"ProductRatePlanChargeTierData",
"ProductRatePlanId",
"TriggerEvent",
"UseDiscountSpecificAccountingCode"
],
"properties": {
"UOM": {
"type": "string",
"nullable": true,
"maxLength": 25,
"description": "Specifies the units to measure usage. \n\n**Note**: You must specify this field when creating the following charge models:\n - Per Unit Pricing\n - Volume Pricing\n - Overage Pricing\n - Tiered Pricing\n - Tiered with Overage Pricing\n"
},
"Name": {
"type": "string",
"maxLength": 100,
"description": "The name of the product rate plan charge.\n"
},
"Formula": {
"type": "string",
"description": "The price lookup formula defined for the product rate plan charge, which is used to identify\nthe correct and relevant charge definition based on the context.\n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing/Price_lookup_in_Attribute-based_Pricing\" target=\"_blank\">Price lookup in Attribute-based Pricing</a>.\n\n\n**Notes**: \n - This field is available only if the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing\" target=\"_blank\">Attribute-based Pricing</a> feature is enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 138 or higher.\n"
},
"TaxCode": {
"type": "string",
"maxLength": 64,
"description": "Specifies the tax code for taxation rules. Required when the Taxable field is set to `True`.\n\n**Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.\n"
},
"TaxMode": {
"enum": [
"TaxExclusive",
"TaxInclusive",
null
],
"type": "string",
"nullable": true,
"description": "Determines how to define taxation for the charge. Required when the Taxable field is set to `True`.\n\n**Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.\n"
},
"Taxable": {
"type": "boolean",
"description": "Determines whether the charge is taxable. When set to `True`, the TaxMode and TaxCode fields are required when creating or updating th ProductRatePlanCharge object.\n\n**Character limit**: 5\n\n**Values**: `True`, `False`\n\n**Note**: This value affects the tax calculation of rate plan charges that come from the `ProductRatePlanCharge`.\n"
},
"IsPrepaid": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. \n\nIndicates whether this charge is a prepayment (topup) charge or a drawdown charge. \n\n**Values**: `true` or `false`.\n"
},
"IsRollover": {
"type": "boolean",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.\n\nThe value is either \"True\" or \"False\". It determines whether the rollover fields are needed.\n"
},
"IsUnbilled": {
"type": "boolean",
"description": "Specifies how to perform the accounting during revenue recognition. The default value is `False`.\n\n**Values**: `True`, `False`\n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.\n"
},
"PrepaidUom": {
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.\n\nUnit of measurement for a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"RevRecCode": {
"type": "string",
"nullable": true,
"maxLength": 70,
"description": "Associates this product rate plan charge with a specific revenue recognition code.\n"
},
"ChargeModel": {
"enum": [
"Discount-Fixed Amount",
"Discount-Percentage",
"Flat Fee Pricing",
"Per Unit Pricing",
"Overage Pricing",
"Tiered Pricing",
"Tiered with Overage Pricing",
"Volume Pricing",
"Delivery Pricing",
"MultiAttributePricing",
"PreratedPerUnit",
"PreratedPricing`",
"HighWatermarkVolumePricing",
"HighWatermarkTieredPricing"
],
"type": "string",
"description": "Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.\n\n**Notes:**\n - The `Delivery Pricing` value is available only if you have the Delivery Pricing charge model enabled.\n - The `MultiAttributePricing` value is available only if you have the Multi-Attribute Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. \n - The `PreratedPerUnit` and value is available only if you have the Pre-rated Per Unit Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. \n - The `PreratedPricing` value is available only if you have the Pre-rated Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. \n - The `HighWatermarkVolumePricing`value is available only if you have the High Water Mark Volume Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. \n - The `HighWatermarkTieredPricing` value is available only if you have the High Water Mark Tiered Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information.\n"
},
"Description": {
"type": "string",
"maxLength": 500,
"description": "A description of the charge.\n"
},
"DrawdownUom": {
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. \n\nUnit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). \n"
},
"MaxQuantity": {
"type": "number",
"format": "double",
"description": "Specifies the maximum number of units for this charge. Use this field and the `MinQuantity` field to create a range of units allowed in a product rate plan charge.\n\n**Character limit**: 16\n\n**Values**: a positive decimal value\n"
},
"MinQuantity": {
"type": "number",
"format": "double",
"description": "Specifies the minimum number of units for this charge. Use this field and the `MaxQuantity` field to create a range of units allowed in a product rate plan charge.\n\n**Character limit**: 16\n\n**Values**: a positive decimal value\n"
},
"ProductLine": {
"type": "string",
"description": "This field is used to maintain the product line for integration with Zuora Revenue. \n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. \n"
},
"RatingGroup": {
"enum": [
"ByBillingPeriod",
"ByUsageStartDate",
"ByUsageRecord",
"ByUsageUpload",
"ByGroupId",
null
],
"type": "string",
"default": "ByBillingPeriod",
"nullable": true,
"description": "Specifies a rating group based on which usage records are rated.\n\nPossible values:\n - `ByBillingPeriod`: The rating is based on all the usages in a billing period. \n - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. \n - `ByUsageRecord`: The rating is based on each usage record.\n - `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`).\n - `ByGroupId`: The rating is based on all the usages in a custom group.\n\n**Note:** \n - The `ByBillingPeriod` value can be applied for all charge models. \n - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. \n - The `ByGroupId` value is only available if you have the Active Rating feature enabled.\n - Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`.\n"
},
"UpToPeriods": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.\n\n**Character limit**: 5\n\n**Values**: a whole number between 0 and 65535, exclusive\n\n**Notes**:\n - You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`. \n - If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.\n"
},
"BillCycleDay": {
"type": "integer",
"format": "int32",
"description": "Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. The BCD value in the account can override the BCD in this object.\n\n**Character limit**: 2\n\n**Values**: a valid BCD integer, 1 - 31\n"
},
"CreditOption": {
"enum": [
"TimeBased",
"ConsumptionBased",
"FullCreditBack"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. \n\nThe way to calculate credit. See [Credit Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option) for more information. \n"
},
"DrawdownRate": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.\n\nThe [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). See [Fields related to Prepaid with Drawdown](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/ProductRatePlanCharge#Fields_related_to_Prepaid_with_Drawdown) for more information.\n"
},
"ProductClass": {
"type": "string",
"description": "This field is used to maintain the product class for integration with Zuora Revenue. \n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.\n"
},
"TriggerEvent": {
"enum": [
"ContractEffective",
"ServiceActivation",
"CustomerAcceptance"
],
"type": "string",
"description": "Specifies when to start billing the customer for the charge.\n\n**Values**:\n - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.\n - `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access.\n - `CustomerAcceptance` is when the customer accepts the services or products for a subscription.\n"
},
"BillCycleType": {
"enum": [
"DefaultFromCustomer",
"SpecificDayofMonth",
"SubscriptionStartDay",
"ChargeTriggerDay",
"SpecificDayofWeek",
"TermStartDay",
"TermEndDay"
],
"type": "string",
"description": "Specifies how to determine the billing day for the charge.\n\n**Notes**:\n - If you set this field to `SpecificDayofMonth`, you must specify which day of the month as the billing day for the charge in the BillCycleDay field. \n - If you set this field to `SpecificDayofWeek`, you must specify which day of the week as the billing day for the charge in the WeeklyBillCycleDay field. \n - By default, `TermStartDay` and `TermEndDay` are only available for prepayment charges. But you can reach out to Zuora Global Support to request enabling it for non-prepaid recurring charges. Meanwhile, note the following rules applies to these options:\n - The Term End Day option of the Billing Day field must be coupled with the Align to Term End option of the Billing Period Alignment field.\n - For prepaid charges, the Term Start Day option of the Billing Day field must be coupled with the existing Align to Term Start option of the Billing Period Alignment field.\n - For non-prepaid recurring charges: If Billing Day is set to Term Start Day, Billing Period Alignment must be Align to Term Start; If Billing Day is set to Term End Day, Billing Period Alignment can be set to other values.\n"
},
"BillingPeriod": {
"enum": [
"Month",
"Quarter",
"Annual",
"Semi-Annual",
"Specific Months",
"Subscription Term",
"Week",
"Specific Weeks",
"Specific Days"
],
"type": "string",
"description": "The billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD).\n\n**Notes**:\n - Specify the number of months or weeks in the SpecificBillingPeriod field if you set this field to `Specific Months` or `Specific Weeks`.\n - The `Subscription Term` value is in **Limited Availability**.\n"
},
"BillingTiming": {
"enum": [
"In Advance",
"In Arrears"
],
"type": "string",
"description": "The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types.\n\nThis 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"
},
"DiscountLevel": {
"enum": [
"rateplan",
"subscription",
"account"
],
"type": "string",
"description": "Specifies if the discount applies to just the product rate plan, the entire subscription, or to any activity in the account.\n"
},
"IncludedUnits": {
"type": "number",
"format": "double",
"description": "Specifies the number of units in the base set of units.\n\n**Character limit**: 16\n\n**Values**: a positive decimal value\n"
},
"ListPriceBase": {
"enum": [
"Per Billing Period",
"Per Month",
"Per Week",
"Per Year",
"Per Specific Months"
],
"type": "string",
"description": "The list price base for the product rate plan charge.\n"
},
"ProductFamily": {
"type": "string",
"description": "This field is used to maintain the product family for integration with Zuora Revenue. \n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.\n"
},
"RolloverApply": {
"enum": [
"ApplyFirst",
"ApplyLast"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.\n\nThis field defines the priority of rollover, which is either first or last.\n"
},
"AccountingCode": {
"type": "string",
"maxLength": 100,
"description": "The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes.\n"
},
"ChargeFunction": {
"enum": [
"Standard",
"Prepayment",
"CommitmentTrueUp",
"Drawdown",
"CreditCommitment",
"DrawdownAndCreditCommitment"
],
"type": "string",
"description": "**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage\" target=\"_blank\">Unbilled Usage</a> feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to `141` or higher. Otherwise, an error occurs.\n\nThis field defines what type of charge it is in Advanced Consumption Billing:\n* Standard: Normal charge with no Prepayment or Commitment or Drawdown.\n* Prepayment: For recurring charges. Unit or currency based prepaid charge.\n* CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge.\n* Drawdown: For usage charges. Drawdown from prepaid funds.\n* DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds.\n* CreditCommitment: For usage charges. Credit to minimum commitment funds.\n"
},
"CommitmentType": {
"enum": [
"UNIT",
"CURRENCY"
],
"type": "string",
"description": "**Note**: This field is only available if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage\" target=\"_blank\">Unbilled Usage</a> feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to `133` or higher. Otherwise, an error occurs. \n\nThis field defines the type of commitment. A prepaid charge can be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can only be `CURRENCY` type. For topup(recurring or one-time) charges, this field indicates what type of funds are created. \n* If UNIT, it will create a fund with given prepaidUom.\n* If CURRENCY, it will create a fund with the currency amount calculated in list price.\n\nFor drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges.\n"
},
"NumberOfPeriod": {
"type": "integer",
"format": "int64",
"description": "Specifies the number of periods to use when calculating charges in an overage smoothing charge model. The valid value must be a positive whole number.\n"
},
"SmoothingModel": {
"enum": [
"RollingWindow",
"Rollover",
null
],
"type": "string",
"nullable": true,
"description": "Specifies the smoothing model for an overage smoothing charge model.\n"
},
"ApplyDiscountTo": {
"enum": [
"ONETIME (1)",
"RECURRING (2)",
"USAGE (4)",
"ONETIMERECURRING (3)",
"ONETIMEUSAGE (5)",
"RECURRINGUSAGE (6)",
"ONETIMERECURRINGUSAGE (7)"
],
"type": "string",
"description": "Specifies the type of charges that you want a specific discount to apply to. All field values are case sensitive and in all-caps.\n"
},
"DefaultQuantity": {
"type": "number",
"format": "double",
"description": "The default quantity of units, such as the number of authors in a hosted wiki service. This field is required if you use a per-unit pricing model. \n\n**Character limit**: 16\n\n**Values**: a valid quantity value. \n\n**Note:** When the `ChargeModel` field is set to `Tiered Pricing` or `Volume Pricing`, if this field is not specified, the value will default to `0`.\n"
},
"PrepaidQuantity": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. \n\nThe number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number.\n"
},
"ProductCategory": {
"type": "string",
"description": "This field is used to maintain the product category for integration with Zuora Revenue. \n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. \n"
},
"RolloverPeriods": {
"type": "number",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.\n\nThis field defines the number of rollover periods, it is restricted to 3.\n"
},
"UpToPeriodsType": {
"enum": [
"Billing Periods",
"Days",
"Weeks",
"Months",
"Years",
null
],
"type": "string",
"default": "Billing Periods",
"nullable": true,
"description": "The period type used to define when the charge ends.\n\n**Notes**: \n - You must use this field together with the `UpToPeriods` field to specify the time period.\n - This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`. \n"
},
"DeliverySchedule": {
"$ref": "#/components/schemas/ProxyCreateOrModifyDeliverySchedule"
},
"EndDateCondition": {
"enum": [
"SubscriptionEnd",
"FixedPeriod"
],
"type": "string",
"default": "SubscriptionEnd",
"description": "Defines when the charge ends after the charge trigger date.\n\n**Values**:\n - `SubscriptionEnd`: The charge ends on the subscription end date after a specified period based on the trigger date of the charge. \n - `FixedPeriod`: The charge ends after a specified period based on the trigger date of the charge. If you set this field to `FixedPeriod`, you must specify the length of the period and a period type by defining the `UpToPeriods` and `UpToPeriodsType` fields. \n\n **Note**: If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date.\n"
},
"IsStackedDiscount": {
"type": "boolean",
"description": "**Note**: This field is only applicable to the Discount - Percentage charge model.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 130 or higher. Otherwise, an error occurs.\n\nThis field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows:\n - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.\n - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.\n\nFor more information, see [Stacked discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models). \n"
},
"PriceChangeOption": {
"enum": [
"NoChange",
"SpecificPercentageValue",
"UseLatestProductCatalogPricing",
null
],
"type": "string",
"default": "NoChange",
"nullable": true,
"description": "Applies an automatic price change when a termed subscription is renewed.\n"
},
"ProductRatePlanId": {
"type": "string",
"maxLength": 32,
"description": "The ID of the product rate plan associated with this product rate plan charge.\n"
},
"ValidityPeriodType": {
"enum": [
"SUBSCRIPTION_TERM",
"ANNUAL",
"SEMI_ANNUAL",
"QUARTER",
"MONTH"
],
"type": "string",
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. \n\nThe period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).\n"
},
"WeeklyBillCycleDay": {
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string",
"description": "Specifies which day of the week as the bill cycle day (BCD) for the charge.\n\nThis 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"
},
"PriceIncreaseOption": {
"enum": [
"FromTenantPercentageValue",
"SpecificPercentageValue"
],
"type": "string",
"description": "Applies an automatic price change when a termed subscription is renewed.\n"
},
"IsAllocationEligible": {
"type": "boolean",
"description": "Indicates whether the charge segment is allocation eligible in revenue recognition. The default value is `False`.\n\n**Values**: `True`, `False`\n\n**Notes**: \n - This field is available only if you have the Additional Revenue Fields property enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.\n"
},
"RolloverPeriodLength": {
"type": "integer",
"default": null,
"description": "**Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled.\n\nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 137 or higher. Otherwise, an error occurs.\n\nThe period length of the rollover fund.\n"
},
"SpecificBillingPeriod": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to `Specific Months` or `Specific Weeks`.\nThe valid value is a positive integer.\n"
},
"SpecificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"nullable": true,
"description": "The number of months for the list price base of the charge. This field is required if you set the value of the `ListPriceBase` field to `Per Specific Months`.\n\n**Notes**: \n - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `129` or later. Otherwise, an error occurs.\n - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.\n"
},
"BillingPeriodAlignment": {
"enum": [
"AlignToCharge",
"AlignToSubscriptionStart",
"AlignToTermStart",
"AlignToTermEnd"
],
"type": "string",
"description": "Aligns charges within the same subscription if multiple charges begin on different dates.\n\n**Note:** The `AlignToTermEnd` value is only available for prepayment charges by default. Reach out to Zuora Global Support to enable it for non-prepaid recurring charges.\n"
},
"DeferredRevenueAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the deferred revenue account for this charge.\n\nThis 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"
},
"LegacyRevenueReporting": {
"type": "boolean",
"description": ""
},
"RevRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate",
null
],
"type": "string",
"nullable": true,
"description": "Specifies when revenue recognition begins.\n"
},
"PriceIncreasePercentage": {
"type": "number",
"format": "double",
"nullable": true,
"description": "Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the value to `SpecificPercentageValue`.\n\n**Character limit**: 16\n\n**Values**: a decimal value between -100 and 100\n"
},
"UsageRecordRatingOption": {
"enum": [
"EndOfBillingPeriod",
"OnDemand",
null
],
"type": "string",
"default": "EndOfBillingPeriod",
"nullable": true,
"description": "Determines how Zuora processes usage records for per-unit usage charges. \n"
},
"ChargeModelConfiguration": {
"$ref": "#/components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfiguration"
},
"OverageCalculationOption": {
"enum": [
"EndOfSmoothingPeriod",
"PerBillingPeriod",
null
],
"type": "string",
"nullable": true,
"description": "Determines when to calculate overage charges. If the value of the SmoothingMode field is not specified, the value of this field is ignored.\n\n**Values**: \n - `EndOfSmoothingPeriod`: This option is used by default. The overage is charged at the end of the smoothing period.\n - `PerBillingPeriod`: The overage is charged on-demand rather than waiting until the end of the smoothing period.\n"
},
"RecognizedRevenueAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the recognized revenue account for this charge.\n - Required when the Allow Blank Accounting Code setting is No.\n - Optional when the Allow Blank Accounting Code setting is Yes.\n\n 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"
},
"RevenueRecognitionTiming": {
"enum": [
"Upon Billing Document Posting Date",
"Upon Order Activation Date"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue recognition timing.\n\nPredefined options are listed as enum values in this API Reference. \nOther options might also be avaliable depending on \nthe <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"RevenueAmortizationMethod": {
"enum": [
"Immediate",
"Ratable Using Start And End Dates"
],
"type": "string",
"maxLength": 200,
"description": "Specifies the type of revenue amortization method.\n\nPredefined options are listed as enum values in this API Reference. \nOther options might also be avaliable depending on \nthe <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy\" target=\"_blank\">revenue recognition policy configuration</a> in the Zuora Billing UI.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"
},
"RevenueRecognitionRuleName": {
"enum": [
"Recognize upon invoicing",
"Recognize daily over time"
],
"type": "string",
"description": "Determines when to recognize the revenue for this charge.\n"
},
"ProductRatePlanChargeNumber": {
"type": "string",
"maxLength": 100,
"description": "The natural key of the product rate plan charge. \n\nFor existing Product Rate Plan Charge objects that are created before this field is introduced, this field will be null. Use this field to specify a value for only these objects. Zuora also provides a tool to help you automatically backfill this field with tenant ID for your existing product catalog. If you want to use this backfill tool, contact [Zuora Global Support](https://support.zuora.com/).\n\n**Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later.\n"
},
"ApplyToBillingPeriodPartially": {
"type": "boolean",
"description": "Allow the discount duration to be aligned with the billing period partially.\n\n**Note**: You must enable the [Enhanced Discount](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.\n"
},
"ProductRatePlanChargeTierData": {
"$ref": "#/components/schemas/ProxyCreateOrModifyProductRatePlanChargeTierData"
},
"OverageUnusedUnitsCreditOption": {
"enum": [
"NoCredit",
"CreditBySpecificRate",
null
],
"type": "string",
"nullable": true,
"description": "Determines whether to credit the customer with unused units of usage.\n"
},
"UseTenantDefaultForPriceChange": {
"type": "boolean",
"description": "Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal. \n\n**Character limit**: 5\n\n**Values**: `true`, `false`\n"
},
"UseDiscountSpecificAccountingCode": {
"type": "boolean",
"nullable": true,
"description": "Determines whether to define a new accounting code for the new discount charge.\n\n**Character limit**: 5\n\n**Values**: `True`, `False`\n"
},
"ExcludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Notes**: \n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.\n - This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
},
"ExcludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude the related rate plan charges and order line items from revenue accounting.\n\n**Notes**: \n - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.\n - This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/ProductRatePlanChargeObjectNSFields"
},
{
"$ref": "#/components/schemas/ProductRatePlanChargeObjectCustomFields"
}
],
"example": {
"UOM": "each",
"Name": "Recurring flat fee",
"ChargeModel": "Flat fee Pricing",
"TriggerEvent": "ContractEffective",
"BillCycleType": "DefaultFromCustomer",
"BillingPeriod": "Month",
"AccountingCode": "Deferred Revenue",
"ProductRatePlanId": "2c92c0f8628e007901628f1dc06a453d",
"DeferredRevenueAccount": "Deferred Revenue",
"RecognizedRevenueAccount": "Accounts Receivable",
"ProductRatePlanChargeTierData": {
"ProductRatePlanChargeTier": [
{
"Price": 10,
"Currency": "USD"
}
]
},
"UseDiscountSpecificAccountingCode": false
}
}
ProxyModifyProductRatePlanChargeTier
{
"type": "object",
"example": {
"Price": 1.99
},
"properties": {
"Price": {
"type": "number",
"format": "double",
"description": "The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.\n"
}
}
}
ProxyModifyUsage
{
"allOf": [
{
"type": "object",
"properties": {
"UOM": {
"type": "string",
"description": " Specifies the units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**.\n**Character limit**: **Values**: a valid unit of measure "
},
"Quantity": {
"type": "number",
"format": "double",
"description": "Indicates the number of units used.\n\n**Character limit**: 16 \n\n**Values**: A valid decimal amount. It could be a negative amount. Negative quantity usage records are used to adjust the previously uploaded usage records.\n"
},
"RbeStatus": {
"type": "string",
"description": " Indicates if the rating and billing engine (RBE) processed usage data for an invoice.\n**Character limit**: 9 **Values**: automatically generated to be one of the following values: `Importing`, `Pending`, `Processed` "
},
"EndDateTime": {
"type": "string",
"format": "date-time",
"description": " The end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation.\n**Character limit**: 29 **Values**: a valid date and time value "
},
"StartDateTime": {
"type": "string",
"format": "date-time",
"description": " The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the `EndDateTime`, the `StartDateTime` field does affect usage calculation.\n**Character limit**: 29 **Values**: a valid date and time value "
}
}
},
{
"$ref": "#/components/schemas/UsageObjectCustomFields"
}
]
}
ProxyNoDataResponse
{
"type": "object",
"properties": {
"done": {
"type": "boolean",
"description": ""
},
"size": {
"type": "integer",
"description": ""
},
"records": {
"type": "array",
"items": {
"type": "object"
},
"description": ""
}
}
}
ProxyPostImport
{
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "The ID of the Import object that was created.\n"
},
"Success": {
"type": "boolean",
"description": "Indicates whether the call succeeded.\n"
}
}
}
ProxyUnauthorizedResponse
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error message.\n\nIf the error message is \"Authentication error\", ensure that the `Authorization` request header contains valid authentication credentials, then retry the request. See [Authentication](https://developer.zuora.com/rest-api/general-concepts/authentication/) for more information.\n\nIf the error message is \"Failed to get user info\", retry the request.\n"
}
}
}
PutBatchInvoiceType
{
"type": "object",
"example": {
"invoices": [
{
"id": "2c93808457d787030157e031d86c4c57",
"autoPay": false,
"dueDate": "2017-12-16",
"transferredToAccounting": "Yes"
},
{
"id": "2c92c8955bd63cc1015bd7c151af02ab",
"autoPay": false,
"dueDate": "2017-12-27",
"transferredToAccounting": "Yes"
},
{
"id": "2c92c8955bd63cc1015bd7c151af02dc",
"invoiceDate": "2017-11-27"
}
]
},
"properties": {
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchInvoiceType"
},
"description": "Container for invoice update details.\n"
}
}
}
PutCancelBillRunRequest
{
"type": "object",
"example": {
"cancelOnce": true
},
"properties": {
"cancelOnce": {
"type": "boolean",
"default": true,
"description": "Whether to cancel the current bill run or cancel all future recurring bill runs, only valid for a scheduled bill run.\n"
}
}
}
PutCascadingPaymentMethodsConfigurationRequest
{
"type": "object",
"example": {
"consent": true,
"priorities": [
{
"order": 1,
"paymentMethodId": "2c92c0f95be68649015bf14e001f2760"
},
{
"order": 2,
"paymentMethodId": "2c92c0f95be68649015bf14e001f2761"
},
{
"order": 3,
"paymentMethodId": "2c92c0f95be68649015bf14e001f2762"
}
]
},
"properties": {
"consent": {
"type": "boolean",
"description": "`true` indicates that you have collected consent from your customer to use the Cascading Payment Method feature. `false` indicates the consent was not collected and the Cascading Payment Method feature is not enabled.\n\nThe `priorities` field can be specified only if `consent` is `true`.\n"
},
"priorities": {
"type": "array",
"items": {
"type": "object",
"required": [
"paymentMethodId",
"order"
],
"properties": {
"order": {
"type": "integer",
"minimum": 1,
"description": "The order of the payment method in the priority list. For example, `1` indicates the payment method is the first one in the priority list, and `2` indicates it is the second.\n\nThe first payment method in the priority list will be the default payment method of the customer account.\n"
},
"paymentMethodId": {
"type": "string",
"description": "The ID of a payment method.\n"
}
}
},
"title": "priority",
"description": "Container for the priority configuration of payment methods. You can add up to three payment methods to this container. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B2_Cascade_payment_methods\" target=\"_blank\">Cascade payment methods</a>.\n\n`priorities` is required if `consent` is `true`.\n"
}
}
}
PutCreditMemoTaxItemType
{
"allOf": [
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the taxation item in the credit memo item.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the taxation item in the credit memo item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific credit memo.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date that the tax is applied to the credit memo, in `yyyy-mm-dd` format.\n"
},
"taxName": {
"type": "string",
"description": "The name of taxation.\n"
},
"taxRate": {
"type": "number",
"format": "double",
"description": "The tax rate applied to the credit memo.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate applied to the credit memo.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field.\n"
},
"taxExemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"onAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"salesTaxPayableAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the sales taxes payable.\n"
}
},
"description": "Container for the finance information related to the taxation item in the credit memo item.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate. \n"
}
}
},
{
"$ref": "#/components/schemas/CreditTaxationItemObjectCustomFields"
}
],
"title": "taxItems"
}
PutDebitMemoTaxItemType
{
"allOf": [
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the taxation item in the debit memo item.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the taxation item in the debit memo item.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to a specific debit memo.\n"
},
"taxDate": {
"type": "string",
"format": "date",
"description": "The date that the tax is applied to the debit memo, in `yyyy-mm-dd` format.\n"
},
"taxName": {
"type": "string",
"description": "The name of taxation.\n"
},
"taxRate": {
"type": "number",
"format": "double",
"description": "The tax rate applied to the debit memo.\n"
},
"taxRateType": {
"enum": [
"Percentage",
"FlatFee"
],
"type": "string",
"description": "The type of the tax rate applied to the debit memo.\n"
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"
},
"locationCode": {
"type": "string",
"description": "The identifier for the location based on the value of the `taxCode` field.\n"
},
"taxExemptAmount": {
"type": "number",
"format": "double",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"salesTaxPayableAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the sales taxes payable.\n"
}
},
"description": "Container for the finance information related to the taxation item in the debit memo item.\n"
},
"taxCodeDescription": {
"type": "string",
"description": "The description of the tax code.\n"
},
"taxRateDescription": {
"type": "string",
"description": "The description of the tax rate.\n"
}
}
},
{
"$ref": "#/components/schemas/DebitTaxationItemObjectCustomFields"
}
],
"title": "taxItems"
}
PutDiscountItemType
{
"allOf": [
{
"type": "object",
"title": "invoiceItems",
"required": [
"amount"
],
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the discount item.\n"
},
"sku": {
"type": "string",
"description": "The SKU of the invoice item. The SKU of the discount item must be different from the SKU of any existing product.\n"
},
"amount": {
"type": "string",
"format": "number",
"description": "The amount of the discount item.\n- Should be a negative number. For example, `-10`.\n- Always a fixed amount no matter whether the discount charge associated with the discount item uses the [fixed-amount model or percentage model](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models#Fixed_amount_model_and_percentage_model).\n- For tax-exclusive discount items, this amount indicates the discount item amount excluding tax.\n- For tax-inclusive discount items, this amount indicates the discount item amount including tax.\n"
},
"itemType": {
"type": "string",
"description": "The type of the discount item.\n"
},
"unitPrice": {
"type": "string",
"format": "number",
"description": "The per-unit price of the discount item.\nIf the discount charge associated with the discount item uses the percentage model, the unit price will display as a percentage amount in PDF. For example: if unit price is 5.00, it will display as 5.00% in PDF.\n"
},
"chargeDate": {
"type": "string",
"format": "date-time",
"description": "The date when the discount item is charged, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"chargeName": {
"type": "string",
"description": "The name of the charge associated with the discount item.\nThis field is required if the `productRatePlanChargeId` field is not specified in the request.\n"
},
"revRecCode": {
"type": "string",
"description": "The revenue recognition code.\n"
},
"description": {
"type": "string",
"description": "The description of the discount item.\n"
},
"accountingCode": {
"type": "string",
"description": "The accounting code associated with the discount item.\n"
},
"bookingReference": {
"type": "string",
"description": "The booking reference of the discount item.\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "The purchase order number associated with the discount item.\n"
},
"revRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate"
],
"type": "string",
"description": "The date when revenue recognition is triggered.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"contractAssetAccountingCode": {
"type": "string",
"description": "The accounting code for contract asset.\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment revenue.\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.\n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for contract liability.\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment liability.\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.\n"
},
"unbilledReceivablesAccountingCode": {
"type": "string",
"description": "The accounting code for unbilled receivables.\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.\n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for contract recognized revenue.\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.\n"
}
}
},
{
"$ref": "#/components/schemas/DiscountItemObjectNSFields"
},
{
"$ref": "#/components/schemas/DiscountItemObjectCustomFields"
}
]
}
PutEventTriggerRequest
{
"type": "object",
"example": {
"condition": "changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 5000",
"eventType": {
"description": "An invoice is posted with amount over 5000"
},
"description": "Trigger an event when an invoice is posted with amount over 5000"
},
"properties": {
"active": {
"type": "boolean",
"description": "The status of the trigger."
},
"condition": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "The JEXL expression to be evaluated against object changes. See above for more information and an example."
},
"eventType": {
"type": "object",
"properties": {
"description": {
"type": "string",
"maxLength": 1000,
"description": "The description for the event type."
},
"displayName": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "The display name for the event type."
}
},
"description": "The type of events to be triggered."
},
"description": {
"type": "string",
"maxLength": 1000,
"description": "The description of the trigger."
}
}
}
PutFulfillmentItemRequestType
{
"type": "object",
"example": {
"description": "description1",
"customFields": {
"PICKLIST_CF__c": "option_1"
},
"itemIdentifier": "0c27b769-5bba-46a5-80aa-cdd95f931216"
},
"properties": {
"description": {
"type": "string",
"description": "The description of the Fulfillment Item.\n"
},
"customFields": {
"$ref": "#/components/schemas/FulfillmentItemCustomFields"
},
"itemIdentifier": {
"type": "string",
"description": "The external identifier of the Fulfillment Item.\n"
}
}
}
PutFulfillmentRequestType
{
"type": "object",
"example": {
"state": "SentToBilling",
"quantity": 5,
"billTargetDate": "2022-01-01",
"fulfillmentDate": "2022-01-01",
"fulfillmentType": "Delivery"
},
"properties": {
"state": {
"enum": [
"Executing",
"Booked",
"SentToBilling",
"Complete",
"Cancelled"
],
"type": "string",
"description": "The state of the Fulfillment. See [Order Line Item states, Order states, and state transitions](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States) for more information.\n"
},
"carrier": {
"type": "string",
"description": "The carrier of the Fulfillment. The available values can be managed in the Fulfillment Settings page under Billing Settings.\n"
},
"quantity": {
"type": "number",
"description": "The quantity of the Fulfillment.\n"
},
"externalId": {
"type": "string",
"description": "The external id of the Fulfillment.\n"
},
"description": {
"type": "string",
"description": "The description of the Fulfillment.\n"
},
"customFields": {
"$ref": "#/components/schemas/FulfillmentCustomFields"
},
"billTargetDate": {
"type": "string",
"format": "date",
"description": "The target date for the Fulfillment to be picked up by bill run for billing.\n"
},
"trackingNumber": {
"type": "string",
"description": "The tracking number of the Fulfillment.\n"
},
"fulfillmentDate": {
"type": "string",
"format": "date",
"description": "The date of the Fulfillment.\n"
},
"fulfillmentType": {
"enum": [
"Delivery",
"Return"
],
"type": "string",
"description": "The type of the Fulfillment. \n"
},
"orderLineItemId": {
"type": "string",
"format": "UUID",
"description": "The reference id of the related Order Line Ite\n"
},
"fulfillmentSystem": {
"type": "string",
"description": "The fulfillment system of the Fulfillment. The available values can be managed in the Fulfillment Settings page under Billing Settings.\n"
},
"fulfillmentLocation": {
"type": "string",
"description": "The fulfillment location of the Fulfillment. The available values can be managed in the Fulfillment Settings page under Billing Settings.\n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude Fulfillment related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"excludeItemBookingFromRevenueAccounting": {
"type": "boolean",
"description": "The flag to exclude Fulfillment from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
}
PutInvoiceItemType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the invoice item.\n"
},
"sku": {
"type": "string",
"description": "The SKU of the invoice item. The SKU of the invoice item must be different from the SKU of any existing product.\n"
},
"uom": {
"type": "string",
"description": "The unit of measure.\n"
},
"amount": {
"type": "string",
"format": "number",
"description": "The amount of the invoice item. \n\n- For tax-inclusive invoice items, the amount indicates the invoice item amount including tax. \n- For tax-exclusive invoice items, the amount indicates the invoice item amount excluding tax.\n"
},
"taxCode": {
"type": "string",
"description": "The tax code identifies which tax rules and tax rates to apply to the invoice item.\n\n**Note:** \n- This field is only available if you have Taxation enabled.\n- If the values of both `taxCode` and `taxMode` fields are changed to `null` when updating a standalone invoice, the corresponding `invoiceItems` > `taxItems` field and its nested fields specified in the creation request will be removed.\n"
},
"taxMode": {
"enum": [
"TaxInclusive",
"TaxExclusive"
],
"type": "string",
"description": "The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.\n\n**Note:** \n- This field is only available if you have Taxation enabled.\n- If the values of both `taxCode` and `taxMode` fields are changed to `null` when updating a standalone invoice, the corresponding `invoiceItems` > `taxItems` field and its nested fields specified in the creation request will be removed.\n"
},
"itemType": {
"type": "string",
"description": "The type of the invoice item.\n"
},
"quantity": {
"type": "string",
"format": "number",
"description": "The number of units for the invoice item.\n"
},
"unitPrice": {
"type": "string",
"format": "number",
"description": "The per-unit price of the invoice item.\n"
},
"chargeDate": {
"type": "string",
"format": "date-time",
"description": "The date when the invoice item is charged, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"chargeName": {
"type": "string",
"description": "The name of the charge associated with the invoice item. \n\nThis field is required if the `productRatePlanChargeId` field is not specified in the request.\n"
},
"revRecCode": {
"type": "string",
"description": "The revenue recognition code.\n"
},
"description": {
"type": "string",
"description": "The description of the invoice item.\n"
},
"discountItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutDiscountItemType"
},
"description": "Container for discount items. The maximum number of discount items is 10.\n"
},
"accountingCode": {
"type": "string",
"description": "The accounting code associated with the invoice item.\n"
},
"serviceEndDate": {
"type": "string",
"format": "date",
"description": "The service end date of the invoice item.\n"
},
"serviceStartDate": {
"type": "string",
"format": "date",
"description": "The service start date of the invoice item.\n"
},
"purchaseOrderNumber": {
"type": "string",
"description": "The purchase order number associated the invoice item.\n"
},
"revRecTriggerCondition": {
"enum": [
"ContractEffectiveDate",
"ServiceActivationDate",
"CustomerAcceptanceDate"
],
"type": "string",
"description": "The date when revenue recognition is triggered.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"description": "The name of the revenue recognition rule governing the revenue schedule.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"contractAssetAccountingCode": {
"type": "string",
"description": "The accounting code for contract asset. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"adjustmentRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment revenue. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"contractLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for contract liability. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n\n**Note:** This field is only available if you have Zuora Finance enabled.\n"
},
"adjustmentLiabilityAccountingCode": {
"type": "string",
"description": "The accounting code for adjustment liability. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"unbilledReceivablesAccountingCode": {
"type": "string",
"description": "The accounting code for unbilled receivables. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"contractRecognizedRevenueAccountingCode": {
"type": "string",
"description": "The accounting code for contract recognized revenue. \n \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
},
"excludeItemBillingFromRevenueAccounting": {
"type": "boolean",
"default": false,
"description": "The flag to exclude the invoice item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
}
}
},
{
"$ref": "#/components/schemas/InvoiceItemObjectNSFields"
},
{
"$ref": "#/components/schemas/InvoiceItemObjectCustomFields"
}
]
}
PutInvoiceResponseType
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the invoice.\n"
},
"amount": {
"type": "number",
"format": "BigDecimal",
"description": "The total amount of the invoice.\n"
},
"number": {
"type": "string",
"description": "The unique identification number of the invoice.\n"
},
"status": {
"enum": [
"Draft",
"Posted",
"Canceled",
"Error"
],
"type": "string",
"description": "The status of the invoice.\n"
},
"autoPay": {
"type": "boolean",
"description": "Whether invoices are automatically picked up for processing in the corresponding payment run. \n"
},
"balance": {
"type": "number",
"format": "BigDecimal",
"description": "The balance of the invoice.\n"
},
"comment": {
"type": "string",
"description": "Comments about the invoice. \n"
},
"dueDate": {
"type": "string",
"format": "date",
"description": "The date by which the payment for this invoice is due. \n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"currency": {
"type": "string",
"description": "A currency defined in the web-based UI administrative settings.\n"
},
"discount": {
"type": "number",
"format": "BigDecimal",
"description": "The discount of the invoice.\n"
},
"postedOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the invoice was posted, in `yyyy-mm-dd hh:mm:ss` format. \n"
},
"accountId": {
"type": "string",
"description": "The ID of the customer account associated with the invoice.\n"
},
"taxAmount": {
"type": "number",
"format": "BigDecimal",
"description": "The amount of taxation.\n"
},
"postedById": {
"type": "string",
"description": "The ID of the Zuora user who posted the invoice.\n"
},
"targetDate": {
"type": "string",
"format": "date",
"description": "The target date for the invoice, in `yyyy-mm-dd` format. For example, 2017-07-20. \n"
},
"cancelledOn": {
"type": "string",
"format": "date-time",
"description": "The date and time when the invoice was cancelled, in `yyyy-mm-dd hh:mm:ss` format.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the invoice.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the invoice was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"invoiceDate": {
"type": "string",
"format": "date",
"description": "The date on which to generate the invoice.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the invoice.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the invoice was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"cancelledById": {
"type": "string",
"description": "The ID of the Zuora user who cancelled the invoice.\n"
},
"totalTaxExemptAmount": {
"type": "number",
"format": "BigDecimal",
"description": "The calculated tax amount excluded due to the exemption.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the invoice was transferred to an external accounting system.\n"
},
"creditBalanceAdjustmentAmount": {
"type": "number",
"format": "BigDecimal",
"description": "**Note:** This filed is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.\nThe currency amount of the adjustment applied to the customer's credit balance.\n"
}
}
},
{
"$ref": "#/components/schemas/InvoiceObjectNSFields"
},
{
"$ref": "#/components/schemas/InvoiceObjectCustomFields"
}
]
}
PutInvoiceType
{
"allOf": [
{
"type": "object",
"properties": {
"autoPay": {
"type": "boolean",
"description": "Whether invoices are automatically picked up for processing in the corresponding payment run.\nBy default, invoices are automatically picked up for processing in the corresponding payment run.\n"
},
"dueDate": {
"type": "string",
"format": "date",
"description": "The date by which the payment for this invoice is due.\n"
},
"comments": {
"type": "string",
"maxLength": 255,
"description": "Additional information related to the invoice that a Zuora user added to the invoice.\n"
},
"invoiceDate": {
"type": "string",
"format": "date",
"description": "The new invoice date of the invoice. The new invoice date cannot fall in a closed accounting period.\nYou can only specify `invoiceDate` or `dueDate` in one request. Otherwise, an error occurs.\n"
},
"invoiceItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutInvoiceItemType"
},
"description": "Container for invoice items, The maximum number of items is 1,000.\n"
},
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the invoice was transferred to an external accounting system.\n"
}
}
},
{
"$ref": "#/components/schemas/InvoiceObjectNSFields"
},
{
"$ref": "#/components/schemas/InvoiceObjectCustomFields"
}
],
"example": {
"id": "2c9890207863df710178642433c307ab",
"autoPay": false,
"comments": "comments",
"accountId": "2c9890207863df710178642433c407a5",
"invoiceDate": "2017-02-20",
"invoiceItems": [
{
"id": "2c9890207863df710178642433c306ba",
"amount": 300,
"quantity": 2,
"chargeDate": "2020-02-01 11:00:00",
"chargeName": "charge with tax amount 9",
"description": "description",
"discountItems": [
{
"id": "2c9890207863df710178642433c3033b",
"sku": "SKU-0002",
"amount": -10,
"unitPrice": -5,
"chargeDate": "2020-02-01 11:00:00",
"chargeName": "discount",
"description": "description",
"bookingReference": "discountBookingReference"
}
],
"serviceEndDate": "2020-02-10",
"bookingReference": "bookingReference",
"serviceStartDate": "2020-02-01"
}
],
"transferredToAccounting": "Yes"
}
}
PutOrderCancelRequest
{
"type": "object",
"properties": {
"cancelReason": {
"type": "string",
"example": "Customer cancelled the order.",
"description": "The reason for cancelling the order."
}
}
}
PutOrderCancelResponse
{
"allOf": [
{
"$ref": "#/components/schemas/CommonResponse"
},
{
"type": "object",
"properties": {
"status": {
"enum": [
"Cancelled"
],
"type": "string",
"description": "Status of the order. `Cancelled` is only valid value."
},
"orderNumber": {
"type": "string",
"description": "The order number of the order created."
},
"cancelReason": {
"type": "string",
"description": "The reason for cancelling the order."
},
"accountNumber": {
"type": "string",
"description": "The account number for the order."
}
}
}
]
}
PutPostBillRunRequest
{
"type": "object",
"example": {
"invoiceDate": "2022-01-01"
},
"required": [
"invoiceDate"
],
"properties": {
"invoiceDate": {
"type": "string",
"format": "date",
"description": "The date that appears on the invoice being created, in `yyyy-mm-dd` format. \n\nThe value cannot fall in a closed accounting period.\n"
}
}
}
PutPublishOpenPaymentMethodTypeResponse
{
"type": "object",
"example": {
"label": "ZuoraQA Amazon Pay",
"fields": [
{
"name": "AmazonToken",
"type": "string",
"index": 1,
"label": "AmazonToken",
"visible": true,
"checksum": true,
"editable": true,
"required": true,
"maxLength": 100,
"minLength": 1,
"description": "The Token value",
"representer": true,
"defaultValue": null
},
{
"name": "AmazonTokenType",
"type": "string",
"index": 2,
"label": "Amazon TokenType",
"visible": true,
"checksum": true,
"editable": true,
"required": true,
"maxLength": 100,
"minLength": 1,
"description": "The Type of Token, e.g. GoCardlessToken",
"representer": true,
"defaultValue": null
}
],
"status": "Published",
"version": "2021-11-22",
"entityId": "",
"revision": 1,
"tenantId": "9",
"internalName": "AmazonPay",
"subTypeField": "AmazonTokenType",
"userReferenceIdField": "AmazonAccount",
"methodReferenceIdField": "AmazonToken"
},
"properties": {
"label": {
"type": "string",
"example": "ZuoraQA Amazon Pay"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "AmazonToken"
},
"type": {
"type": "string",
"example": "string"
},
"index": {
"type": "number",
"example": 1
},
"label": {
"type": "string",
"example": "AmazonToken"
},
"visible": {
"type": "boolean",
"example": true
},
"checksum": {
"type": "boolean",
"example": true
},
"editable": {
"type": "boolean",
"example": true
},
"required": {
"type": "boolean",
"example": true
},
"maxLength": {
"type": "number",
"example": 100
},
"minLength": {
"type": "number",
"example": 1
},
"description": {
"type": "string",
"example": "The Token value"
},
"representer": {
"type": "boolean",
"example": true
},
"defaultValue": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
}
}
}
},
"status": {
"type": "string",
"example": "Published"
},
"version": {
"type": "string",
"example": "2021-11-22"
},
"entityId": {
"type": "string",
"example": ""
},
"revision": {
"type": "number",
"example": 1
},
"tenantId": {
"type": "string",
"example": "9"
},
"internalName": {
"type": "string",
"example": "AmazonPay"
},
"subTypeField": {
"type": "string",
"example": "AmazonTokenType"
},
"userReferenceIdField": {
"type": "string",
"example": "AmazonAccount"
},
"methodReferenceIdField": {
"type": "string",
"example": "AmazonToken"
}
}
}
PutReverseCreditMemoResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"debitMemo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the debit memo."
}
},
"description": "Container for the debit memo that is automatically generated during the credit memo reversal.\n"
},
"creditMemo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the credit memo."
}
},
"description": "Container for the credit memo that is automatically generated during the reversal of the invoice that is related to the credit memo. If no related invoice is reversed, the value is null.\n"
}
}
}
PutReverseCreditMemoType
{
"type": "object",
"example": {
"memoDate": "2017-02-20",
"applyEffectiveDate": "2017-02-20"
},
"properties": {
"memoDate": {
"type": "string",
"format": "date",
"description": "The date when the debit memo is created, in `yyyy-mm-dd` format. The memo date must be later than or equal to the credit memo's memo date.\n\nThe default value is the date when you reverse the credit memo and create the debit memo.\n"
},
"applyEffectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the to-be-reversed credit memo is applied to the newly generated debit memo, in `yyyy-mm-dd` format. The effective date must be later than or equal to the memo date.\n\nThe default value is the date when you reverse the credit memo and create the debit memo.\n"
}
}
}
PutReverseInvoiceResponseType
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully.\n"
},
"debitMemo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the debit memo."
}
},
"description": "Container for the debit memo that is automatically generated during the reversal of the credit memo related to this invoice. If no related credit memo is reversed, this field is not retruned in the response body.\n"
},
"creditMemo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the credit memo."
}
},
"description": "Container for the credit memo that is automatically generated when during the invoice reversal.\n"
}
}
}
PutReverseInvoiceType
{
"type": "object",
"example": {
"memoDate": "2017-02-20",
"applyEffectiveDate": "2017-02-20"
},
"properties": {
"memoDate": {
"type": "string",
"format": "date",
"description": "The date when the credit memo was created, in `yyyy-mm-dd` format. The memo date must be later than or equal to the invoice date.\n\nThe default value is the date when you reverse the invoice and create the credit memo.\n"
},
"applyEffectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the credit memo is applied to the invoice that will be reversed, in `yyyy-mm-dd` format. The effective date must be later than or equal to the memo date.\n\nThe default value is the date when you reverse the invoice and create the credit memo.\n"
}
}
}
PutScheduledEventRequest
{
"type": "object",
"example": {
"hours": 10,
"active": true,
"minutes": 30,
"condition": "Subscription.Status == _SUBSCRIPTION_STATUS",
"parameters": {
"_SUBSCRIPTION_STATUS": {
"options": [
"Draft",
"Active",
"Pending",
"Expired",
"Cancelled"
],
"valueType": "STRING",
"description": "The status of the subscription",
"displayName": "Subscription Status"
}
},
"description": "Trigger a scheduled event at 10:30 AM based on TermEndDate of subscription objects.",
"displayName": "Term End Date Scheduled Event"
},
"properties": {
"hours": {
"type": "integer",
"maximum": 23,
"minimum": 0,
"description": "The scheduled time (hour) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant."
},
"active": {
"type": "boolean",
"description": "Indicate whether the scheduled event is active or inactive"
},
"minutes": {
"type": "integer",
"maximum": 59,
"minimum": 0,
"description": "The scheduled time (minute) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant."
},
"condition": {
"type": "string",
"maxLength": 65535,
"description": "The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The scheduled event is triggered only if the condition is evaluated as true.\nThe rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects).\nScheduled events with invalid merge fields will fail to evaluate, thus will not be triggered. For example, to trigger an invoice due date scheduled event to only invoices with an amount over 1000, you would define the following condition:\n\n```Invoice.Amount > 1000```\n\n`Invoice.Amount` refers to the `Amount` field of the Zuora object `Invoice`.\n"
},
"parameters": {
"type": "object",
"description": "The parameters of the filter rule. The names of the parameters must match with the filter rule and can't be duplicated.",
"additionalProperties": {
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "The option values of the parameter."
},
"valueType": {
"enum": [
"STRING",
"BYTE",
"SHORT",
"CHARACTER",
"INTEGER",
"LONG",
"FLOAT",
"DOUBLE",
"BOOLEAN",
"BIG_INTEGER",
"BIG_DECIMAL",
"LOCAL_DATE",
"LOCAL_DATE_TIME",
"TIMESTAMP",
"BYTE_ARRAY",
"SHORT_ARRAY",
"CHARACTER_ARRAY",
"INTEGER_ARRAY",
"FLOAT_ARRAY",
"DOUBLE_ARRAY",
"BOOLEAN_ARRAY",
"STRING_ARRAY",
"BIG_INTEGER_ARRAY",
"BIG_DECIMAL_ARRAY",
"LOCAL_DATE_ARRAY",
"LOCAL_DATE_TIME_ARRAY",
"TIMESTAMP_ARRAY"
],
"type": "string",
"description": "The type of the value."
},
"description": {
"type": "string",
"maxLength": 255,
"description": "The description of the parameter."
},
"displayName": {
"type": "string",
"maxLength": 255,
"description": "The display name of the parameter."
}
},
"description": "Definition of a filter rule parameter."
}
},
"description": {
"type": "string",
"maxLength": 1000,
"description": "The description of the scheduled event."
},
"displayName": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "The display name of the scheduled event."
}
}
}
PutStopBookingDateBackfillJobByIdRequest
{
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"enum": [
"Stopping"
],
"type": "string",
"description": "`Stopping` is currently the only allowed value.\n"
}
}
}
PutStopDataBackfillJobByIdRequest
{
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"enum": [
"Stopping"
],
"type": "string",
"description": "`Stopping` is currently the only allowed value.\n"
}
}
}
PutTasksRequest
{
"type": "object",
"example": {
"data": [
{
"id": 2771,
"name": "If",
"tags": [],
"object": null,
"status": "Success",
"call_type": "SOAP",
"object_id": null,
"action_type": "If",
"workflow_id": 476,
"concurrent_limit": 9999999
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateTask"
},
"maximum": 50,
"minimum": 1,
"description": "The list of tasks to update.\n"
}
}
}
PutUpdateOpenPaymentMethodTypeResponse
{
"type": "object",
"example": {
"status": "Draft",
"revision": 2,
"publishDate": "",
"paymentMethodType": "AmazonPay__c_12368"
},
"properties": {
"status": {
"type": "string",
"example": "Draft"
},
"revision": {
"type": "number",
"example": 2
},
"publishDate": {
"type": "string",
"example": ""
},
"paymentMethodType": {
"type": "string",
"example": "AmazonPay__c_12368"
}
}
}
QuantityForUsageCharges
{
"allOf": [
{
"type": "object",
"properties": {
"chargeId": {
"type": "string",
"description": "The ID of the subscription charge.\n"
},
"quantity": {
"type": "number",
"description": "The quantity of the subscription charge.\n"
}
}
}
]
}
QueryCustomObjectRecordsResponse
{
"type": "object",
"required": [
"count",
"records"
],
"properties": {
"count": {
"type": "integer",
"example": 1,
"description": "The record count of the given custom object type"
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomObjectRecordWithAllFields"
},
"example": [
{
"Id": "f4f3d0a8-9d45-43d6-956c-4820f2de7559",
"type": "person",
"age__c": 32,
"version": 1,
"email__c": "smith123@example.com",
"CreatedById": "58bcc694-0b01-4c38-83d9-679891aee4dc",
"CreatedDate": "2017-06-07T17:26:47.501Z",
"UpdatedById": "58bcc694-0b01-4c38-83d9-679891aee4dc",
"UpdatedDate": "2017-06-07T17:26:47.501Z",
"last_name__c": "Smith",
"home_address__c": "59b38ad1-27d4-40e8-af66-8c138bc382ee",
"work_address__c": "8a19f16a-2b5e-4a26-bb20-c79cd6984714",
"marital_status__c": "Married"
}
]
}
}
}
QuoteObjectFields
{
"type": "object",
"title": "quote",
"properties": {
"QuoteType__QT": {
"type": "string",
"description": "The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel.\n\nThis field is used in the Zuora Reporting Data Sources to report on Subscription metrics.\n\nIf the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n\n**Character limit**: 32\n"
},
"QuoteNumber__QT": {
"type": "string",
"description": "The unique identifier of the Quote.\n\nThis field is used in the Zuora Reporting Data Sources to report on Subscription metrics.\n\nIf the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n\n**Character limit**: 32\n"
},
"OpportunityName__QT": {
"type": "string",
"description": "The unique identifier of the Opportunity. \n\nThis field is used in the Zuora Reporting Data Sources to report on Subscription metrics.\n\nIf the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n\n**Character limit**: 100\n"
},
"QuoteBusinessType__QT": {
"type": "string",
"description": "The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn.\n\nThis field is used in the Zuora Reporting Data Sources to report on Subscription metrics.\n\nIf the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n\n**Character limit**: 32\n"
},
"OpportunityCloseDate__QT": {
"type": "string",
"description": "The closing date of the Opportunity.\n\nThis field is used in Zuora Reporting Data Sources to report on Subscription metrics.\n\nIf the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n"
}
},
"description": "The fields populated for a quote when a quote is sent to Zuora Billing from Zuora Quote.\n"
}
RampChargeRequest
{
"type": "object",
"title": "RampCharge",
"properties": {
"uniqueToken": {
"type": "string",
"description": "Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.\n"
},
"chargeNumber": {
"type": "string",
"description": "The number of the rate plan charge."
}
}
}
RampChargeResponse
{
"type": "object",
"title": "charges",
"properties": {
"chargeNumber": {
"type": "string",
"description": "The number of the rate plan charge."
}
}
}
RampIntervalChargeDeltaMetrics
{
"type": "object",
"title": "intervalDeltaMetrics",
"properties": {
"deltaMrr": {
"type": "array",
"items": {
"type": "object",
"properties": {
"net": {
"type": "number",
"description": "The MRR delta amount after discounts charges are applied."
},
"gross": {
"type": "number",
"description": "The MRR delta amount before discounts charges are applied."
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date."
},
"discount": {
"type": "number",
"description": "The discount delta amount for the MRR."
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date."
}
}
},
"description": "The MRR changing history of the current rate plan charge in the current ramp interval."
},
"deltaNetTcb": {
"type": "number",
"description": "The TCB delta value after discount charges are applied."
},
"deltaNetTcv": {
"type": "number",
"description": "The TCV delta value after discount charges are applied."
},
"chargeNumber": {
"type": "string",
"description": "The number of the rate plan charge."
},
"deltaGrossTcb": {
"type": "number",
"description": "The TCB delta value before discount charges are applied."
},
"deltaGrossTcv": {
"type": "number",
"description": "The TCV delta value before discount charges are applied."
},
"deltaQuantity": {
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "The delta amount of the charge quantity."
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date."
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date."
}
}
},
"description": "The charge quantity changing history of the current rate plan charge in the current ramp interval."
},
"deltaDiscountTcb": {
"type": "number",
"description": "The discount delta amount for the TCB."
},
"deltaDiscountTcv": {
"type": "number",
"description": "The discount delta amount for the TCV."
},
"subscriptionNumber": {
"type": "string",
"description": "The number of the subscription that the current rate plan charge belongs to."
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of the corresponding product rate plan charge."
}
}
}
RampIntervalChargeMetrics
{
"type": "object",
"title": "intervalMetrics",
"properties": {
"mrr": {
"type": "array",
"items": {
"type": "object",
"properties": {
"net": {
"type": "number",
"description": "The net MRR amount after discounts charges are applied."
},
"gross": {
"type": "number",
"description": "The gross MRR amount before discounts charges are applied."
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date."
},
"discount": {
"type": "number",
"description": "The discount amount for the MRR."
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date."
}
}
},
"description": "The MRR changing history of the current rate plan charge in the current ramp interval."
},
"netTcb": {
"type": "number",
"description": "The net TCB value after discount charges are applied."
},
"netTcv": {
"type": "number",
"description": "The net TCV value after discount charges are applied."
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date of the rate plan charge in the current ramp interval."
},
"grossTcb": {
"type": "number",
"description": "The gross TCB value before discount charges are applied."
},
"grossTcv": {
"type": "number",
"description": "The gross TCV value before discount charges are applied."
},
"quantity": {
"type": "number",
"description": "The quantity of the rate plan charge."
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the rate plan charge in the current ramp interval."
},
"discountTcb": {
"type": "number",
"description": "The discount amount for the TCB."
},
"discountTcv": {
"type": "number",
"description": "The discount amount for the TCV."
},
"chargeNumber": {
"type": "string",
"description": "The number of the charge."
},
"ratePlanChargeId": {
"type": "string",
"description": "The ID of the rate plan charge."
},
"subscriptionNumber": {
"type": "string",
"description": "The number of the subscription that the current rate plan charge belongs to."
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of the corresponding product rate plan charge."
}
}
}
RampIntervalMetrics
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the interval."
},
"netTcb": {
"type": "number",
"description": "The net TCB value after discount charges are applied."
},
"netTcv": {
"type": "number",
"description": "The net TCV value after discount charges are applied."
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date of the interval."
},
"grossTcb": {
"type": "number",
"description": "The gross TCB value before discount charges are applied."
},
"grossTcv": {
"type": "number",
"description": "The gross TCV value before discount charges are applied."
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the interval."
},
"description": {
"type": "string",
"description": "The short description of the interval."
},
"discountTcb": {
"type": "number",
"description": "The discount amount for the TCB."
},
"discountTcv": {
"type": "number",
"description": "The discount amount for the TCV."
},
"intervalMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RampIntervalChargeMetrics"
},
"description": "Container for the detailed metrics for each rate plan charge in each ramp interval."
}
}
}
RampIntervalRequest
{
"type": "object",
"title": "intervals",
"required": [
"startDate",
"endDate"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the interval."
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date of the interval."
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the interval."
},
"description": {
"type": "string",
"description": "The short description of the interval."
}
},
"description": "Container for the intervals that the ramp is split into in its timeline. Zuora can report metrics for this specific period.\n"
}
RampIntervalResponse
{
"type": "object",
"title": "intervals",
"properties": {
"name": {
"type": "string",
"description": "The name of the interval."
},
"endDate": {
"type": "string",
"format": "date",
"description": "The end date of the interval."
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the interval."
},
"description": {
"type": "string",
"description": "The short description of the interval."
}
}
}
RampMetrics
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the ramp."
},
"netTcb": {
"type": "number",
"description": "The net TCB value after discount charges are applied."
},
"netTcv": {
"type": "number",
"description": "The net TCV value after discount charges are applied."
},
"number": {
"type": "string",
"description": "The number of the ramp. It is automaticcally generated by the billing system."
},
"grossTcb": {
"type": "number",
"description": "The gross TCB value before discount charges are applied."
},
"grossTcv": {
"type": "number",
"description": "The gross TCV value before discount charges are applied."
},
"intervals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RampIntervalMetrics"
},
"description": "Container for the intervals that the ramp is split into in its timeline."
},
"description": {
"type": "string",
"description": "The short description of the ramp."
},
"discountTcb": {
"type": "number",
"description": "The discount amount for the TCB."
},
"discountTcv": {
"type": "number",
"description": "The discount amount for the TCV."
}
}
}
RampRequest
{
"type": "object",
"title": "Ramp",
"properties": {
"name": {
"type": "string",
"description": "The name of the ramp."
},
"delete": {
"type": "boolean",
"description": "Whether to remove the ramp definition from the new subscription. If you want to remove the ramp definition, this field is the only required field for the `ramp` object. \n"
},
"charges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RampChargeRequest"
},
"description": "Container for the rate plan charges that are considered as part of the ramp deal.\n\n* If this field is not specified, all the one-time and recurring regular charges of the new subscription are automatically considered as part of the ramp deal.\n* If this field is specified, either 'chargeNumber' or 'uniqueToken' must be specified.\n"
},
"intervals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RampIntervalRequest"
},
"description": "Container for the intervals that the ramp is split into in its timeline. \n\nIt is required when you want to create or update the ramp definition. The ramp intervals cannot have any overlap or gap between each other.\n"
},
"description": {
"type": "string",
"description": "The short description of the ramp."
}
},
"description": "Container of the ramp definitions. It is used to create, update, or remove the ramp definition for the new subscription.\n"
}
RampResponse
{
"type": "object",
"title": "Ramp",
"properties": {
"id": {
"type": "string",
"description": "The ID of the ramp."
},
"name": {
"type": "string",
"description": "The name of the ramp."
},
"number": {
"type": "string",
"description": "The number of the ramp. It is automaticcally generated by the billing system."
},
"charges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RampChargeResponse"
},
"description": "Container for the rate plan charges that are considered as part of the ramp deal."
},
"intervals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RampIntervalResponse"
},
"description": "Container for the intervals that the ramp is split into in its timeline."
},
"description": {
"type": "string",
"description": "The short description of the ramp."
},
"subscriptionNumber": {
"type": "string",
"description": "The number of the subscription that is considered as part of the ramp deal."
}
}
}
RatePlan
{
"type": "object",
"properties": {
"customFields": {
"$ref": "#/components/schemas/CustomFields"
},
"productRatePlanId": {
"type": "string",
"description": "Internal identifier of the product rate plan that the rate plan is based on.\n"
}
}
}
RatePlanChargeObjectCustomFields
{
"type": "object",
"title": "ratePlanChargeFieldsCustom",
"description": "Container for custom fields of a Rate Plan Charge object.\n",
"additionalProperties": {
"description": "Custom fields of the Rate Plan Charge object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
RatePlanFeatureOverride
{
"type": "object",
"title": "ratePlanFeature",
"properties": {
"id": {
"type": "string",
"description": "Internal identifier of the rate plan feature override.\n"
},
"featureId": {
"type": "string",
"description": "Internal identifier of the feature in the product catalog.\n"
},
"description": {
"type": "string",
"maxLength": 500,
"description": "A description of the feature."
},
"customFields": {
"$ref": "#/components/schemas/RatePlanFeatureOverrideCustomFields"
}
},
"description": "Information about feature in rate plan.\n"
}
RatePlanFeatureOverrideCustomFields
{
"type": "object",
"title": "ratePlanFeatureCustom",
"description": "A container for custom fields of the feature.\n",
"additionalProperties": {
"description": "Custom fields of the feature. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
RatePlanObjectCustomFields
{
"type": "object",
"title": "ratePlanFieldsCustom",
"description": "Container for custom fields of a Rate Plan object.\n",
"additionalProperties": {
"description": "Custom fields of the Rate Plan object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
RatePlanOverride
{
"type": "object",
"title": "ratePlan",
"required": [
"productRatePlanId"
],
"properties": {
"uniqueToken": {
"type": "string",
"maxLength": 50,
"description": "Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora.\n\nFor instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrdersRatePlanObjectCustomFields"
},
"ratePlanName": {
"type": "string",
"description": "Name of the standalone rate plan.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"newRatePlanId": {
"type": "string",
"description": "Internal identifier of the rate plan.\n"
},
"chargeOverrides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeOverride"
},
"description": "List of charges associated with the rate plan.\n"
},
"productRatePlanId": {
"type": "string",
"description": "Internal identifier of the product rate plan that the rate plan is based on.\n"
},
"isFromExternalCatalog": {
"type": "boolean",
"description": "Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription.\n"
},
"externallyManagedPlanId": {
"type": "string",
"description": "Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n"
},
"clearingExistingFeatures": {
"type": "boolean",
"description": "Specifies whether all features in the rate plan will be cleared.\n"
},
"subscriptionRatePlanNumber": {
"type": "string",
"maxLength": 50,
"description": "Number of a subscription rate plan for this subscription.\n"
},
"subscriptionProductFeatures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RatePlanFeatureOverride"
},
"description": "List of features associated with the rate plan.\nThe system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:\n* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.\n* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan. \n"
}
},
"description": "Rate plan associated with a subscription.\n"
}
RatePlanUpdate
{
"type": "object",
"title": "updateProduct",
"properties": {
"ratePlanId": {
"type": "string",
"description": "Internal identifier of the rate plan that was updated. It can be the latest version or any history version id.\n"
},
"uniqueToken": {
"type": "string",
"description": "A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.\n"
},
"customFields": {
"$ref": "#/components/schemas/OrdersRatePlanObjectCustomFields"
},
"chargeUpdates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeUpdate"
},
"description": "Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.\n"
},
"newRatePlanId": {
"type": "string",
"description": "Internal identifier of the updated rate plan in the new subscription version.\n"
},
"specificUpdateDate": {
"type": "string",
"format": "date",
"description": "\nThe date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.\n\nSee [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription.\n"
},
"externallyManagedPlanId": {
"type": "string",
"description": "Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.\n"
},
"clearingExistingFeatures": {
"type": "boolean",
"description": "Specifies whether all features in the rate plan will be cleared.\n"
},
"subscriptionRatePlanNumber": {
"type": "string",
"description": "Number of a rate plan for this subscription.\n"
},
"subscriptionProductFeatures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RatePlanFeatureOverride"
},
"description": "List of features associated with the rate plan.\nThe system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:\n* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.\n* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.\n"
}
},
"description": "Information about an order action of type `UpdateProduct`.\n"
}
RatePlans
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RatePlan"
}
}
RecurringDeliveryPricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"listPrice": {
"type": "number",
"description": "Price of the charge in each recurring period.\n"
},
"priceIntervals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceIntervalWithPrice"
},
"description": "List of interval pricing in the charge. \nThe `priceIntervals` field is not supported for a charge subscribed via a RatePlan, you can only override the `priceIntervals` field for a charge subscribed via an offer.\n\n**Note**: You must enable the Offers feature to access this field. The Offers 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. If you want to join this early adopter program, submit a request at <a href=\"https://support.zuora.com/hc/en-us\" target=\"_blank\">Zuora Global Support</a>.\n"
},
"deliverySchedule": {
"$ref": "#/components/schemas/DeliveryScheduleParams"
}
}
}
],
"title": "recurringDelivery",
"description": "Pricing information about a recurring charge that uses the Delivery Pricing charge model. In this charge model, the charge has a fixed price. This field is only available if you have the Delivery Pricing charge model enabled.\n"
}
RecurringDeliveryPricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"listPrice": {
"type": "number"
},
"deliverySchedule": {
"$ref": "#/components/schemas/DeliveryScheduleParams"
}
}
}
]
}
RecurringFlatFeePricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"listPrice": {
"type": "number",
"description": "Price of the charge in each recurring period.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year",
"Per_Specific_Months"
],
"type": "string",
"description": "Specifies the duration of each recurring period.\n"
},
"priceIntervals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceIntervalWithPrice"
},
"description": "List of interval pricing in the charge. \nThe `priceIntervals` field is not supported for a charge subscribed via a RatePlan, you can only override the `priceIntervals` field for a charge subscribed via an offer. \n\n**Note**: You must enable the Offers feature to access this field. The Offers 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. If you want to join this early adopter program, submit a request at <a href=\"https://support.zuora.com/hc/en-us\" target=\"_blank\">Zuora Global Support</a>.\n"
},
"originalListPrice": {
"type": "number",
"description": "The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"description": "The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.\n\n**Note**: \n - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`. \n"
}
}
}
],
"title": "recurringFlatFee",
"description": "Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"
}
RecurringFlatFeePricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"listPrice": {
"type": "number"
},
"originalListPrice": {
"type": "number",
"description": "The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n"
}
}
}
]
}
RecurringPerUnitPricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"uom": {
"type": "number",
"description": "Unit of measure of the standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"quantity": {
"type": "number",
"minimum": 0,
"description": "Number of units purchased.\n"
},
"listPrice": {
"type": "number",
"description": "Per-unit price of the charge in each recurring period.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year",
"Per_Specific_Months"
],
"type": "string",
"description": "Specifies the duration of each recurring period.\n"
},
"priceIntervals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceIntervalWithPrice"
},
"description": "List of interval pricing in the charge. \nThe `priceIntervals` field is not supported for a charge subscribed via a RatePlan, you can only override the `priceIntervals` field for a charge subscribed via an offer. \n\n**Note**: You must enable the Offers feature to access this field. The Offers 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. If you want to join this early adopter program, submit a request at <a href=\"https://support.zuora.com/hc/en-us\" target=\"_blank\">Zuora Global Support</a>.\n"
},
"originalListPrice": {
"type": "number",
"description": "The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"description": "The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.\n\n**Note**: \n - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`. \n"
}
}
}
],
"title": "recurringPerUnit",
"description": "Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n"
}
RecurringPerUnitPricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"quantity": {
"type": "number",
"minimum": 0
},
"listPrice": {
"type": "number"
},
"originalListPrice": {
"type": "number",
"description": "The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n"
}
}
}
]
}
RecurringTieredPricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeTier"
},
"description": "List of cumulative pricing tiers in the charge.\n"
},
"quantity": {
"type": "number",
"minimum": 0,
"description": "Number of units purchased.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year",
"Per_Specific_Months"
],
"type": "string",
"description": "Specifies the duration of each recurring period.\n"
},
"priceIntervals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceIntervalWithTiers"
},
"description": "List of tier prices with intervals. \nThe `priceIntervals` field is not supported for a charge subscribed via a RatePlan, you can only override the `priceIntervals` field for a charge subscribed via an offer.\n\n**Note**: You must enable the Offers feature to access this field. The Offers 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. If you want to join this early adopter program, submit a request at <a href=\"https://support.zuora.com/hc/en-us\" target=\"_blank\">Zuora Global Support</a>.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"description": "The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.\n\n**Note**: \n - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`. \n"
}
}
}
],
"title": "recurringTiered",
"description": "Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n"
}
RecurringTieredPricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeTier"
}
},
"quantity": {
"type": "number",
"minimum": 0
}
}
}
]
}
RecurringVolumePricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"uom": {
"type": "number",
"description": "Unit of measure of the standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeTier"
},
"description": "List of variable pricing tiers in the charge.\n"
},
"quantity": {
"type": "number",
"minimum": 0,
"description": "Number of units purchased.\n"
},
"listPriceBase": {
"enum": [
"Per_Billing_Period",
"Per_Month",
"Per_Week",
"Per_Year",
"Per_Specific_Months"
],
"type": "string",
"description": "Specifies the duration of each recurring period.\n"
},
"priceIntervals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceIntervalWithTiers"
},
"description": "List of tier prices with intervals. \nThe `priceIntervals` field is not supported for a charge subscribed via a RatePlan, you can only override the `priceIntervals` field for a charge subscribed via an offer.\n\n**Note**: You must enable the Offers feature to access this field. The Offers 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. If you want to join this early adopter program, submit a request at <a href=\"https://support.zuora.com/hc/en-us\" target=\"_blank\">Zuora Global Support</a>.\n"
},
"specificListPriceBase": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1,
"description": "The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`.\n\n**Note**: \n - This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price\" target=\"_blank\">Annual List Price</a> feature enabled.\n - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`. \n"
}
}
}
],
"title": "recurringVolume",
"description": "Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n"
}
RecurringVolumePricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeTier"
}
},
"quantity": {
"type": "number",
"minimum": 0
}
}
}
]
}
RefundCreditMemoItemType
{
"type": "object",
"title": "items",
"required": [
"amount"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the refund on the specific item.\n"
},
"creditTaxItemId": {
"type": "string",
"description": "The ID of the credit memo taxation item that is refunded.\n"
},
"creditMemoItemId": {
"type": "string",
"description": "The ID of the credit memo item that is refunded.\n"
}
}
}
RefundEntityPrefix
{
"type": "object",
"title": "refund",
"properties": {
"prefix": {
"type": "string",
"example": "R-",
"description": "The prefix of refunds.\n"
},
"startNumber": {
"type": "integer",
"example": 10,
"description": "The starting number of refunds.\n"
}
},
"description": "Container for the prefix and starting number of refunds.\n"
}
RefundObjectCustomFields
{
"type": "object",
"title": "refundFieldsCustom",
"description": "Container for custom fields of a Refund object.\n",
"additionalProperties": {
"description": "Custom fields of the Refund object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
RefundObjectNSFields
{
"type": "object",
"title": "refundFieldsNS",
"properties": {
"Origin__NS": {
"type": "string",
"maxLength": 255,
"description": "Origin of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"SyncDate__NS": {
"type": "string",
"maxLength": 255,
"description": "Date when the refund was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationId__NS": {
"type": "string",
"maxLength": 255,
"description": "ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"SynctoNetSuite__NS": {
"type": "string",
"maxLength": 255,
"description": "Specifies whether the refund should be synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationStatus__NS": {
"type": "string",
"maxLength": 255,
"description": "Status of the refund's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
},
"description": "Container for Refund fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
RefundPartResponseType
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the refund part.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the refund part.\n"
},
"success": {
"type": "boolean",
"description": "Returns `true` if the request was processed successfully."
},
"paymentId": {
"type": "string",
"description": "The ID of the payment associated with the refund part.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the refund part.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the refund part.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund part was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo associated with the refund part.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
}
}
}
RefundPartResponseTypewithSuccess
{
"type": "object",
"title": "parts",
"properties": {
"id": {
"type": "string",
"description": "The ID of the refund part.\n"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the refund part.\n"
},
"paymentId": {
"type": "string",
"description": "The ID of the payment associated with the refund part.\n"
},
"createdById": {
"type": "string",
"description": "The ID of the Zuora user who created the refund part.\n"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.\n"
},
"updatedById": {
"type": "string",
"description": "The ID of the Zuora user who last updated the refund part.\n"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the refund part was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo associated with the refund part.\n"
},
"organizationLabel": {
"type": "string",
"description": "The organization that this object belongs to.\n\nNote: This field is available only when the Multi-Org feature is enabled.\n"
}
}
}
RegenerateBillingRequest
{
"type": "object",
"example": {
"type": "CreditMemo",
"number": "CM00000001"
},
"properties": {
"type": {
"enum": [
"Invoice",
"CreditMemo",
"DebitMemo",
"InvoiceItemAdjustment"
],
"type": "string",
"description": "The type of business object for which you want to generate the transactions.\n"
},
"number": {
"type": "string",
"description": "Number of Invoice, CreditMemo, DebitMemo, or InvoiceItemAdjustment\n"
},
"documentId": {
"type": "string",
"description": "Id of Invoice, CreditMemo, DebitMemo, or InvoiceItemAdjustment\n"
}
}
}
RegenerateBookingRequest
{
"type": "object",
"example": {
"type": "Subscription",
"subscriptionName": "A-S00000001",
"subscriptionVersion": 1
},
"properties": {
"type": {
"enum": [
"Subscription",
"OrderLineItem"
],
"type": "string",
"description": "The type of business object for which you want to generate the transactions.\n"
},
"itemNumber": {
"type": "string",
"description": "The item number.\n"
},
"orderNumber": {
"type": "string",
"description": "The order number.\n"
},
"subscriptionId": {
"type": "string",
"description": "The subscription ID.\n"
},
"orderLineItemId": {
"type": "string",
"description": "The order line item ID.\n"
},
"subscriptionNumber": {
"type": "string",
"description": "The subscription number.\n"
},
"subscriptionVersion": {
"type": "integer",
"description": "The subscription version.\n"
}
}
}
RegenerateRevRecEventsResponse
{
"type": "object",
"properties": {
"reasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponseReasons"
}
},
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded.\n"
}
}
}
RegenerateTransactionObjectResponse
{
"type": "object",
"properties": {
"idList": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of the IDs for the business objects for which you generate the transactions. \n"
},
"reasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponseReasons"
}
},
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded.\n"
}
}
}
RemoveProduct
{
"type": "object",
"title": "removeProduct",
"properties": {
"ratePlanId": {
"type": "string",
"description": "ID of the rate plan to remove. This can be the latest version or any history version of ID.\n"
},
"uniqueToken": {
"type": "string",
"description": "Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora."
},
"customFields": {
"type": "object",
"title": "ratePlanFieldsCustom",
"description": "Container for custom fields of a Rate Plan object.\n",
"additionalProperties": {
"type": "object",
"description": "Custom fields of the Rate Plan object. The name of each custom field has\nthe form <code>*customField*__c</code>. Custom field names are case\nsensitive. See [Manage Custom\nFields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields)\nfor more information.\n"
}
},
"chargeUpdates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderActionRatePlanChargeRemove"
}
},
"externalCatalogPlanId": {
"type": "string",
"description": "An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to remove the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case.\n\n**Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.\n"
},
"productRatePlanNumber": {
"type": "string",
"description": "Number of a product rate plan for this subscription.\n"
},
"subscriptionRatePlanNumber": {
"type": "string",
"description": "Number of a rate plan for this subscription.\n"
}
},
"description": "Information about an order action of type `RemoveProduct`.\n"
}
RenewSubscription
{
"type": "object",
"title": "RenewSubscription",
"properties": {
"paymentTerm": {
"type": "string",
"description": "The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body..\n"
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the subscription.\n \n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"maxLength": 255,
"description": "The number of the invoice group associated with the subscription.\n\nAfter enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"clearingExistingPaymentTerm": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingSequenceSet": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingBillToContact": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingSoldToContact": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingInvoiceTemplate": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingInvoiceGroupNumber": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
}
},
"description": "Information about an order action of type `RenewSubscription`.\n"
}
RenewalTerm
{
"type": "object",
"properties": {
"period": {
"type": "integer",
"description": "Duration of the renewal term in months, years, days, or weeks, depending on the value of the `periodType` field.\n"
},
"periodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"description": "Unit of time that the renewal term is measured in.\n"
}
}
}
ResendCalloutNotificationsFailedResponse
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The error code of response.\n"
},
"message": {
"type": "string",
"description": "The detail information of the error response"
}
},
"description": "The ID of a fail-to-resend callout notification history object, containing an object with the error code and message.\n\n**Note:** Multiple records of this field are allowed in the response. Each of them represents a fail-to-resend callout notification history.\n"
}
}
ResendEmailNotificationsFailedResponse
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The error code of response.\n"
},
"message": {
"type": "string",
"description": "The detail information of the error response"
}
},
"description": "The ID of a fail-to-resend email notification history object, containing an object with the error code and message.\n\n**Note:** Multiple records of this field are allowed in the response. Each of them represents a fail-to-resend email notification history.\n"
}
}
ResponseReasons
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The error code of response.\n"
},
"message": {
"type": "string",
"description": "The detail information of the error response.\n"
}
}
}
RevproAccountingCodes
{
"type": "object",
"example": {
"contractAssetAccount": "CA-2",
"productRatePlanChargeId": "2c92c0f962470b8101624b869fcd45fc",
"adjustmentRevenueAccount": "adjustRev-1",
"contractLiabilityAccount": "CL-2",
"recognizedRevenueAccount": "ContractRevRec-1",
"adjustmentLiabilityAccount": "adjustL-1",
"unbilledReceivablesAccount": "unbilledR-1"
},
"required": [
"productRatePlanChargeId",
"contractAssetAccount",
"contractLiabilityAccount",
"unbilledReceivablesAccount",
"adjustmentLiabilityAccount",
"recognizedRevenueAccount",
"adjustmentRevenueAccount"
],
"properties": {
"contractAssetAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the account where the Account Type is \"Contract Asset\"."
},
"productRatePlanChargeId": {
"type": "string",
"description": "The ID of your product rate plan charge."
},
"adjustmentRevenueAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the account where the Account Type is \"Adjustment Revenue\"."
},
"contractLiabilityAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the account where the Account Type is \"Contract Liability\"."
},
"recognizedRevenueAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the account where the Account Type is \"Recognized Revenue\"."
},
"adjustmentLiabilityAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the account where the Account Type is \"Adjustment Liability\"."
},
"unbilledReceivablesAccount": {
"type": "string",
"maxLength": 100,
"description": "The name of the account where the Account Type is \"Unbilled Receivables\"."
}
}
}
SaveResult
{
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": ""
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionsErrorResponse"
},
"description": ""
},
"Success": {
"type": "boolean",
"description": ""
}
}
}
ScheduleItemsResponse
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the invoice schedule item.\n"
},
"name": {
"type": "string",
"maxLength": 100,
"description": "The name of the invoice schedule item.\n"
},
"amount": {
"type": "string",
"format": "number",
"description": "The amount of the invoice generated during the processing of the invoice schedule item.\n\nYou can only specify either the `amount` field or `percentage` field in one request. \n- If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. \n- If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount.\n\nThe value of this field keeps unchanged once invoice schedule items are created. \n"
},
"status": {
"enum": [
"Pending",
"Executing",
"Processed"
],
"type": "string",
"description": "The status of the invoice schedule item.\n"
},
"runDate": {
"type": "string",
"format": "date",
"description": "The date in the tenant’s time zone when the invoice schedule item is processed to generate an invoice.\n"
},
"invoiceId": {
"type": "string",
"description": "The ID of the invoice that is generated during the processing of the invoice schedule item.\n"
},
"percentage": {
"description": "The percentage of the total amount to be billed during the processing of the invoice schedule item. \n\nYou can only specify either the `amount` field or `percentage` field in one request. \n- If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. \n- If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount.\n"
},
"actualAmount": {
"type": "string",
"format": "number",
"description": "The actual amount that needs to be billed during the processing of the invoice schedule item.\n\nBy default, the actual amount is the same as the total amount. Even if order changes occur like Remove Product or Cancel Subscription, the value of the `amount` field keeps unchanged. The value of the `actualAmount` field reflects the actual amount to be billed.\n"
},
"creditMemoId": {
"type": "string",
"description": "The ID of the credit memo that is generated during the processing of the invoice schedule item.\n"
},
"targetDateForAdditionalSubscriptions": {
"type": "string",
"format": "date",
"description": "The date in the tenant's time zone used by the invoice schedule to determine which fixed-period regular charges to be billed together with the invoice schedule item. \n\nThe regular charges must come from the subscriptions specified in the `additionalSubscriptionsToBill` field.\n"
}
}
},
{
"$ref": "#/components/schemas/InvoiceScheduleItemCustomFields"
},
{}
],
"title": "scheduleItems"
}
SettingComponentKeyValue
{
"type": "object",
"title": "SettingComponentKeyValue",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigurationTemplateContent"
}
},
"originalPayload": {
"$ref": "#/components/schemas/JsonNode"
},
"segregationKeys": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Provides details about the individual components that need to be compared and deployed."
}
SettingItemHttpOperation
{
"type": "object",
"title": "httpOperation",
"properties": {
"url": {
"type": "string",
"description": "The endpoint url of the operation method. For example, `/settings/billing-rules`."
},
"method": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"TRACE"
],
"type": "string",
"description": "One of the HTTP methods supported by the setting endpoint, for example, GET,PUT,POST or DELETE."
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SettingItemHttpRequestParameter"
},
"description": "An array of paramters required by this operation."
},
"requestType": {
"type": "object",
"description": "JSON Schema for the request body of this operation."
},
"responseType": {
"type": "object",
"description": "JSON Schema for the response body of this operation."
}
}
}
SettingItemHttpRequestParameter
{
"type": "object",
"title": "httpRequestParameter",
"properties": {
"name": {
"type": "string",
"description": "The name of the parameter."
},
"description": {
"type": "string",
"description": "The description of the paramter."
}
}
}
SettingItemWithOperationsInformation
{
"type": "object",
"title": "settingItem",
"properties": {
"key": {
"type": "string",
"description": "The unique key to distinguish the setting item."
},
"context": {
"enum": [
"Tenant",
"Entity",
"User",
"None"
],
"type": "string",
"description": "The context where this setting item is effective."
},
"description": {
"type": "string",
"description": "The description of the setting item as you see from Zuora UI."
},
"pathPattern": {
"type": "string",
"description": "The path pattern of the setting endpoint, relative to `/settings`. For example, `/billing-rules`."
},
"httpOperations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SettingItemHttpOperation"
},
"description": "An array of HTTP operation methods that are supported on this setting endpoint."
}
}
}
SettingSourceComponentResponse
{
"type": "object",
"title": "SettingSourceComponentResponse",
"properties": {
"settings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SettingComponentKeyValue"
}
},
"workflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SettingComponentKeyValue"
}
},
"customFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SettingComponentKeyValue"
}
},
"customObjects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SettingComponentKeyValue"
}
},
"notifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SettingComponentKeyValue"
}
},
"productCatalog": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SettingComponentKeyValue"
}
},
"dataAccessControl": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SettingComponentKeyValue"
}
}
},
"description": "Provides details about the different components that need to be compared and deployed."
}
SettingValueRequest
{
"type": "object",
"title": "settingsRequest",
"properties": {
"id": {
"type": "string",
"description": "The id of the request. You can set it to any string. It must be unique within the whole batch.\n"
},
"url": {
"type": "string",
"description": "The relative URL of the setting. It is the same as in the `pathPattern` field in the response body of [Listing all Settings](https://developer.zuora.com/api-references/api/operation/GET_ListAllSettings). For example, `/billing-rules`.\n"
},
"body": {
"$ref": "#/components/schemas/BodyInSettingValueRequest"
},
"method": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"TRACE"
],
"type": "string",
"description": "One of the HTTP methods supported by the setting endpoint, for example, GET,PUT,POST or DELETE.\n"
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChildrenSettingValueRequest"
},
"description": "An array of requests that can only be executed after its parent request has been executed successfully.\n"
}
}
}
SettingValueResponse
{
"type": "object",
"title": "settingsValueResponse",
"properties": {
"body": {
"$ref": "#/components/schemas/BodyInSettingValueReponse"
},
"status": {
"type": "string",
"description": "User readable response status, for example, 502 BAD_GATEWAY.\n"
},
"errorMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of error messages if errors occur when executing the request.\n"
}
}
}
SettingValueResponseWrapper
{
"type": "object",
"title": "settingsValueResponseWrapper",
"properties": {
"id": {
"type": "string",
"description": "The Id of the corresponding request.\n"
},
"url": {
"type": "string",
"description": "The url as specified in the corresponding request.\n"
},
"method": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"TRACE"
],
"type": "string",
"description": "The HTTP method. It is the same as that of the corresponding request.\n"
},
"response": {
"$ref": "#/components/schemas/SettingValueResponse"
}
}
}
SettingsBatchRequest
{
"type": "object",
"example": {
"requests": [
{
"id": "1X",
"url": "/billing-rules",
"method": "GET"
},
{
"id": "2X",
"url": "/accounting-rules",
"method": "GET"
}
]
},
"properties": {
"requests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SettingValueRequest"
}
}
}
}
SettingsBatchResponse
{
"type": "object",
"title": "batchResponse",
"properties": {
"responses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SettingValueResponseWrapper"
}
}
}
}
SignUpCreatePMPayPalECPayPalNativeEC
{
"type": "object",
"properties": {
"BAID": {
"type": "string",
"description": "ID of a PayPal billing agreement, for example, I-1TJ3GAGG82Y9.\n"
},
"email": {
"type": "string",
"description": "Email address associated with the payment method. This field is only supported for PayPal payment methods and is required if you want to create any of the following PayPal payment methods:\n - PayPal Express Checkout payment method \n - PayPal Adaptive payment method\n - PayPal Commerce Platform payment method\n"
}
}
}
SignUpCreatePaymentMethodCardholderInfo
{
"type": "object",
"title": "cardHolderInfo",
"required": [
"cardHolderName"
],
"properties": {
"city": {
"type": "string",
"description": "City, 40 characters or less.\n"
},
"email": {
"type": "string",
"description": "Card holder's email address, 80 characters or less.\n"
},
"phone": {
"type": "string",
"description": "Phone number, 40 characters or less.\n"
},
"state": {
"type": "string",
"description": "State; must be a valid state name or 2-character abbreviation.\n"
},
"country": {
"type": "string",
"description": "Country, must be a valid country name or abbreviation.\n"
},
"zipCode": {
"type": "string",
"description": "Zip code, 20 characters or less.\n"
},
"addressLine1": {
"type": "string",
"description": "First address line, 255 characters or less.\n"
},
"addressLine2": {
"type": "string",
"description": "Second address line, 255 characters or less.\n"
},
"cardHolderName": {
"type": "string",
"description": "The card holder's full name as it appears on the card, e.g., \"John J Smith\", 50 characters or less.\n"
}
},
"description": "Container for cardholder information. If provided, Zuora will\nonly use this information for this card. Otherwise, Zuora will use\nthe account''s existing bill-to contact information for this card.\n"
}
SignUpCreatePaymentMethodCommon
{
"type": "object",
"properties": {
"ipAddress": {
"type": "string",
"description": "The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. \n\nIf the IP address length is beyond 45 characters, a validation error occurs.\n"
},
"accountKey": {
"type": "string",
"description": "Internal ID of the customer account that will own the payment method.\n"
},
"authGateway": {
"type": "string",
"description": "Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.\n\nIf you do not set this field, Zuora will use one of the following payment gateways instead:\n\n* The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set.\n* The default payment gateway of your Zuora tenant, if the `accountKey` field is not set.\n"
},
"makeDefault": {
"type": "boolean",
"default": false,
"description": "Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set.\n"
}
}
}
SignUpCreatePaymentMethodCreditCard
{
"type": "object",
"properties": {
"cardType": {
"type": "string",
"description": "The type of the credit card.\n\nPossible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).\n"
},
"cardNumber": {
"type": "string",
"description": "Credit card number.\n"
},
"securityCode": {
"type": "string",
"description": "CVV or CVV2 security code of the credit card.\n\nTo ensure PCI compliance, this value is not stored and cannot be queried.\n"
},
"cardHolderInfo": {
"$ref": "#/components/schemas/SignUpCreatePaymentMethodCardholderInfo"
},
"expirationYear": {
"type": "string",
"description": "Four-digit expiration year of the credit card.\n"
},
"mitProfileType": {
"enum": [
"Recurring"
],
"type": "string",
"description": "Required if you set the `mitProfileAction` field. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field.\n"
},
"checkDuplicated": {
"type": "boolean"
},
"expirationMonth": {
"type": "string",
"description": "One or two digit expiration month (1-12) of the credit card.\n"
},
"mitProfileAction": {
"enum": [
"Activate",
"Persist"
],
"type": "string",
"description": "Specifies how Zuora creates and activates the stored credential profile. If you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field.\n"
},
"mitProfileAgreedOn": {
"type": "string",
"format": "date",
"description": "The date on which the profile is agreed. The date format is `yyyy-mm-dd`.\n"
},
"mitConsentAgreementRef": {
"type": "string",
"maxLength": 128,
"description": "Specifies your reference for the stored credential consent agreement that you have established with the customer. Only applicable if you set the `mitProfileAction` field.\n"
},
"mitConsentAgreementSrc": {
"enum": [
"External"
],
"type": "string",
"description": "Required if you set the `mitProfileAction` field. Specifies how the consent agreement has been established with the customer. The allowed value is `External`. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field.\n"
},
"mitNetworkTransactionId": {
"type": "string",
"maxLength": 128,
"description": "Specifies the ID of a network transaction. Only applicable if you set the `mitProfileAction` field to `Persist`.\n"
}
}
}
SignUpCreatePaymentMethodCreditCardReferenceTransaction
{
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"description": "The token id of payment method, required field of CreditCardReferenceTransaction type.\n"
},
"secondTokenId": {
"type": "string",
"description": "The second token id of CreditCardReferenceTransaction.\n"
}
}
}
SignUpCreatePaymentMethodPayPalAdaptive
{
"type": "object",
"properties": {
"preapprovalKey": {
"type": "string",
"description": "The PayPal preapproval key.\n"
}
}
}
SignUpPaymentMethod
{
"allOf": [
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"PayPalEC",
"PayPalNativeEC",
"PayPalAdaptive",
"CreditCard",
"CreditCardReferenceTransaction"
],
"type": "string",
"description": "Type of payment method. The following types of the payment method are supported:\n"
}
}
},
{
"$ref": "#/components/schemas/SignUpCreatePaymentMethodCreditCardReferenceTransaction"
},
{
"$ref": "#/components/schemas/SignUpCreatePMPayPalECPayPalNativeEC"
},
{
"$ref": "#/components/schemas/SignUpCreatePaymentMethodPayPalAdaptive"
},
{
"$ref": "#/components/schemas/SignUpCreatePaymentMethodCreditCard"
},
{
"$ref": "#/components/schemas/SignUpCreatePaymentMethodCommon"
},
{
"$ref": "#/components/schemas/SignUpPaymentMethodObjectCustomFields"
}
]
}
SignUpPaymentMethodObjectCustomFields
{
"type": "object",
"title": "paymentMethodFieldsCustom",
"description": "Container for custom fields of a payment method object.\n",
"additionalProperties": {
"description": "Custom fields of the payment method. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
SignUpRequest
{
"type": "object",
"example": {
"options": {
"runBilling": true,
"collectPayment": true,
"billingTargetDate": "2021-07-01",
"maxSubscriptionsPerAccount": 0
},
"accountData": {
"name": "User",
"autoPay": false,
"currency": "USD",
"billCycleDay": "15",
"customFields": {
"CustomerUserId__c": "User_269145114619000"
},
"billToContact": {
"state": "California",
"country": "US",
"lastName": "bar",
"firstName": "foo"
},
"paymentMethod": {
"type": "CreditCardReferenceTransaction",
"tokenId": "User_269145114619000",
"makeDefault": true,
"secondTokenId": "010"
}
},
"subscriptionData": {
"terms": {
"autoRenew": false,
"initialTerm": {
"period": 6,
"termType": "TERMED",
"startDate": "2021-04-15",
"periodType": "Month"
},
"renewalTerms": [
{
"period": 6,
"periodType": "Month"
}
],
"renewalSetting": "RENEW_WITH_SPECIFIC_TERM"
},
"ratePlans": [
{
"productRatePlanId": "4028818284f5f8130184f5fe1a73101f"
}
],
"startDate": "2021-04-15",
"invoiceSeparately": false
},
"accountIdentifierField": "CustomerUserId__c"
},
"properties": {
"options": {
"$ref": "#/components/schemas/Options"
},
"accountData": {
"$ref": "#/components/schemas/AccountData"
},
"paymentData": {
"$ref": "#/components/schemas/PaymentData"
},
"customFields": {
"$ref": "#/components/schemas/CustomFields"
},
"subscriptionData": {
"$ref": "#/components/schemas/SubscriptionData"
},
"accountIdentifierField": {
"type": "string",
"description": "Specify the name of the field that holds external account id"
}
}
}
SignUpResponse
{
"type": "object",
"properties": {
"status": {
"enum": [
"Completed",
"Pending"
],
"type": "string",
"description": "Status of the order. `Pending` is only applicable for an order that contains a `CreateSubscription` order action."
},
"reasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SignUpResponse_reasons"
}
},
"success": {
"type": "boolean",
"description": "Indicates whether the call succeeded.\n"
},
"accountId": {
"type": "string",
"description": "The account id for the order."
},
"invoiceId": {
"type": "string",
"description": "The invoice id generated in this order request"
},
"paymentId": {
"type": "string",
"description": "The payment id that is collected in this order request."
},
"processId": {
"type": "string",
"description": "The Id of the process that handles the operation.\n"
},
"paidAmount": {
"type": "string",
"description": "The total amount collected in this order request."
},
"orderNumber": {
"type": "string",
"description": "The order number of the order created."
},
"creditMemoId": {
"type": "string",
"description": "An array of the credit memo id generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled."
},
"accountNumber": {
"type": "string",
"description": "The account number for the order."
},
"invoiceNumber": {
"type": "string",
"description": "The invoice number generated in this order request"
},
"paymentNumber": {
"type": "string",
"description": "The payment number that is collected in this order request."
},
"subscriptionId": {
"type": "string",
"description": "The subscription id of the order."
},
"creditMemoNumber": {
"type": "string",
"description": "An array of the credit memo numbers generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled."
},
"subscriptionNumber": {
"type": "string",
"description": "The subscription number of the order."
}
}
}
SignUpResponse_reasons
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The error code of response.\n"
},
"message": {
"type": "string",
"description": "The detail information of the error response\n"
}
}
}
SignUpTaxInfo
{
"type": "object",
"title": "taxInfo",
"properties": {
"VATId": {
"type": "string",
"maxLength": 25,
"description": "EU Value Added Tax ID.\n\n**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com).\n"
},
"companyCode": {
"type": "string",
"maxLength": 50,
"description": "Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara.\n\n**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com).\n"
},
"exemptStatus": {
"enum": [
"No",
"Yes",
"PendingVerification"
],
"type": "string",
"default": "No",
"description": "Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax. \n"
},
"exemptDescription": {
"type": "string",
"maxLength": 500,
"description": "Description of the tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"exemptCertificateId": {
"type": "string",
"maxLength": 32,
"description": "ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"exemptEffectiveDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption starts, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"exemptExpirationDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption expires, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"exemptCertificateType": {
"type": "string",
"maxLength": 32,
"description": "Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"exemptIssuingJurisdiction": {
"type": "string",
"maxLength": 32,
"description": "Jurisdiction in which the customer tax exemption certificate was issued.\n"
}
},
"description": "Information about the tax exempt status of a customer account.\n"
}
SoldToContact
{
"allOf": [
{
"type": "object",
"required": [
"firstName",
"lastName"
],
"properties": {
"fax": {
"type": "string",
"maxLength": 40,
"description": "Fax number of the contact.\n"
},
"city": {
"type": "string",
"maxLength": 40,
"description": "City of the contact's address.\n"
},
"state": {
"type": "string",
"maxLength": 40,
"description": "State or province of the contact's address.\n"
},
"county": {
"type": "string",
"maxLength": 32,
"description": "County of the contact's address.\n"
},
"country": {
"type": "string",
"maxLength": 64,
"description": "Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.\n"
},
"address1": {
"type": "string",
"maxLength": 255,
"description": "First line of the contact's address. This is often a street address or a business name.\n"
},
"address2": {
"type": "string",
"maxLength": 255,
"description": "Second line of the contact's address.\n"
},
"lastName": {
"type": "string",
"maxLength": 100,
"description": "Last name of the contact.\n"
},
"nickname": {
"type": "string",
"maxLength": 100,
"description": "Nickname of the contact.\n"
},
"firstName": {
"type": "string",
"maxLength": 100,
"description": "First name of the contact.\n"
},
"homePhone": {
"type": "string",
"maxLength": 40,
"description": "Home phone number of the contact.\n"
},
"taxRegion": {
"type": "string",
"maxLength": 32,
"description": "Region defined in your taxation rules. Only applicable if you use Zuora Tax.\n"
},
"workEmail": {
"type": "string",
"format": "email",
"maxLength": 80,
"description": "Business email address of the contact.\n"
},
"workPhone": {
"type": "string",
"maxLength": 40,
"description": "Business phone number of the contact.\n"
},
"otherPhone": {
"type": "string",
"maxLength": 40,
"description": "Additional phone number of the contact. Use the `otherPhoneType` field to specify the type of phone number.\n"
},
"postalCode": {
"type": "string",
"maxLength": 20,
"description": "ZIP code or other postal code of the contact's address.\n"
},
"mobilePhone": {
"type": "string",
"maxLength": 40,
"description": "Mobile phone number of the contact.\n"
},
"personalEmail": {
"type": "string",
"format": "email",
"maxLength": 80,
"description": "Personal email address of the contact.\n"
},
"otherPhoneType": {
"enum": [
"Work",
"Mobile",
"Home",
"Other"
],
"type": "string",
"description": "Specifies the type of phone number in the `otherPhone` field.\n"
}
},
"description": "Contact details associated with an account.\n"
},
{
"$ref": "#/components/schemas/ContactObjectCustomFields"
}
]
}
SoldToContactPostOrder
{
"allOf": [
{
"type": "object",
"required": [
"firstName",
"lastName"
],
"properties": {
"fax": {
"type": "string",
"maxLength": 40,
"description": "Fax number of the contact.\n"
},
"city": {
"type": "string",
"maxLength": 40,
"description": "City of the contact's address.\n"
},
"state": {
"type": "string",
"maxLength": 40,
"description": "State or province of the contact's address.\n"
},
"county": {
"type": "string",
"maxLength": 32,
"description": "County of the contact's address.\n"
},
"country": {
"type": "string",
"maxLength": 64,
"description": "Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.\n"
},
"address1": {
"type": "string",
"maxLength": 255,
"description": "First line of the contact's address. This is often a street address or a business name.\n"
},
"address2": {
"type": "string",
"maxLength": 255,
"description": "Second line of the contact's address.\n"
},
"lastName": {
"type": "string",
"maxLength": 100,
"description": "Last name of the contact.\n"
},
"nickname": {
"type": "string",
"maxLength": 100,
"description": "Nickname of the contact.\n"
},
"firstName": {
"type": "string",
"maxLength": 100,
"description": "First name of the contact.\n"
},
"homePhone": {
"type": "string",
"maxLength": 40,
"description": "Home phone number of the contact.\n"
},
"taxRegion": {
"type": "string",
"maxLength": 32,
"description": "Region defined in your taxation rules. Only applicable if you use Zuora Tax.\n"
},
"workEmail": {
"type": "string",
"format": "email",
"maxLength": 80,
"description": "Business email address of the contact.\n"
},
"workPhone": {
"type": "string",
"maxLength": 40,
"description": "Business phone number of the contact.\n"
},
"otherPhone": {
"type": "string",
"maxLength": 40,
"description": "Additional phone number of the contact. Use the `otherPhoneType` field to specify the type of phone number.\n"
},
"postalCode": {
"type": "string",
"maxLength": 20,
"description": "ZIP code or other postal code of the contact's address.\n"
},
"mobilePhone": {
"type": "string",
"maxLength": 40,
"description": "Mobile phone number of the contact.\n"
},
"personalEmail": {
"type": "string",
"format": "email",
"maxLength": 80,
"description": "Personal email address of the contact.\n"
},
"otherPhoneType": {
"enum": [
"Work",
"Mobile",
"Home",
"Other"
],
"type": "string",
"description": "Specifies the type of phone number in the `otherPhone` field.\n"
},
"contactDescription": {
"type": "string",
"maxLength": 100,
"description": "A description for the contact. \n"
}
},
"description": "Contact details associated with an account.\n"
},
{
"$ref": "#/components/schemas/ContactObjectCustomFields"
}
]
}
SourceValidityPeriodInfo
{
"type": "object",
"title": "sourceValidityPeriod",
"required": [
"startDate",
"endDate"
],
"properties": {
"endDate": {
"type": "string",
"format": "date",
"description": "End date of the source validity period."
},
"startDate": {
"type": "string",
"format": "date",
"description": "Start date of the source validity period."
}
},
"description": "Date range of the source validity period from which the funds are transferred. It should be close to the destination validity period."
}
StopWorkflowRunError
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The error code."
},
"title": {
"type": "string",
"description": "Error title."
},
"status": {
"type": "number",
"description": "Status code."
}
}
},
"description": "The error messages"
}
}
}
StopWorkflowRunSuccess
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "The indicator for whether the operation to stop a workflow run was a success."
}
}
}
SubmitBatchQueryRequest
{
"type": "object",
"example": {
"name": "Example",
"format": "csv",
"partner": "salesforce",
"project": "00170000011K3Ub",
"queries": [
{
"name": "AccountingPeriod",
"type": "zoqlexport",
"query": "select Id,StartDate,EndDate,FiscalYear,Name,Status from AccountingPeriod"
}
],
"version": "1.1",
"encrypted": "none",
"sourceData": "LIVE",
"dateTimeUtc": "true",
"useQueryLabels": "true"
},
"properties": {
"name": {
"type": "string",
"description": "The name of the job. 32 character limit.\n"
},
"format": {
"enum": [
"csv",
"zip",
"gzip"
],
"type": "string",
"description": "The format of the query. The default value is `csv`.\n"
},
"offset": {
"type": "integer",
"default": 0,
"description": "This field specifies the time offset for AQuA queries in stateful mode. It is an integer in the range 0 to 3,600 seconds.\n\nFor example, if you set this field to 600 seconds and you post a query in stateful mode at 2:00 AM, it will query against data created or updated between the completion time of the previous query and 1:50 AM.\n\nThe value of this field will override the value you configured in **Settings** > **Administration** > **AQuA API Stateful Mode Time Offset**. \n"
},
"partner": {
"type": "string",
"description": "The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days.\nIt must be used together with \"project\" field to uniquely identify a data integration target.\n\nFor example, if a continuous AQuA session is to retrieve data incrementally for a Salesforce.com Org 00170000011K3Ub, you can use partner as \"Salesforce\", and \"project\" as \"00170000011K3Ub.\" \nThis field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.\n\n**Note**: Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Bulk_data__extraction_from_Zuora_using_AQuA\" target=\"_blank\">Bulk data extraction from Zuora using AQuA</a> for best practices.\n**Note**: Submit a request at <a href=\"http://support.zuora.com\" target=\"_blank\">Zuora Global Support</a> to obtain a partner ID.\n"
},
"project": {
"type": "string",
"description": "The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days.\n\nThis field must be used together with partner field to uniquely identify a data integration target. \n\nThis field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.\n"
},
"queries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchQuery"
},
"required": [
"name",
"query"
],
"description": "A JSON array object that contains a list of batch objects.\n"
},
"version": {
"type": "number",
"format": "float",
"description": "The API version you want to use. \n\nThe supported versions are as follows:\n - `1.1`. It supports both modes\n - `1.0`. Default. It supports stateless modes only.\n\nSee <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/BA_Stateless_and_Stateful_Modes\" target=\"_blank\">Stateless and stateful modes</a> for more information.\n"
},
"notifyUrl": {
"type": "string",
"description": "If URL is provided, the AQuA job will call this `notifyUrl` once the job has completed. The value of `notifyUrl` needs to have `${JOBID}` and `${STATUS}` placeholders. These placeholders will be replaced by the actual job ID and status when returned in the response. Status will be `Completed` after the AQuA job is done.\n\nIf you submit an AQuA query with `notifyUrl` specified, the value of `notifyUrl` will be ignored if your organization has already <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Callout_Notification_for_Completed_AQuA_Jobs\" target=\"_blank\">configured a callout notification through the Zuora user interface</a>. \n"
},
"sourceData": {
"enum": [
"LIVE"
],
"type": "string",
"description": "Specify the source this aggregate query runs against:\n\n* `LIVE` represents the live transactional databases at Zuora (Data Query Live).\nIf this field is not specified, the default value `LIVE` will be used.\n"
},
"dateTimeUtc": {
"type": "boolean",
"description": "When using WSDL 69 and later you can ensure that the exported output of dateTime records are rendered according to ISO-8601 generic UTC form by setting `dateTimeUtc` to `true`.\n\nWhen `dateTimeUtc` is set to `true`, exports of dateTime data types will be rendered in the following generic format: `YYYY-MM-DDThh:mm:ss-hhmm` or `YYYY-MM-DDThh:mm:ss+hhmm`.\n\n**Note**: Regardless of what batchType query is used (`zoql` or `zoqlexport`), the query response output for datetime data types can be standardized by setting dateTimeUtc to `true`. When `true`, the results will display datetime types with the format: YYYY-MM-DDThh:mm:ss+/-hhmm.\n"
},
"useQueryLabels": {
"type": "boolean",
"description": "When this optional flag is set to `true` the request will use object and field API names for the CSV header output instead of the field labels. Data integration projects should set `useQueryLabels` to `true` so that API names remain the same.\n\nBy default `useQueryLabels` is `false`, so that output CSV headers display the more user-friendly object and field labels. \n"
},
"incrementalTime": {
"type": "string",
"format": "dateTime",
"description": "Allows you to override the time from which a Stateful AQuA job incrementally retrieves records that have been created or modified, using the `incrementalTime` parameter. For example, if you set `incrementalTime` = `2015-01-21 10:30:01`, AQuA will retrieve records that have created or modified beginning at 10:30:01. If this parameter is not set, AQuA continues to use the Start Time of the last AQuA session to retrieve records incrementally.\n\nThe time zone of `incrementalTime` depends on which Zuora data center you use. For US Data Center customers, the time zone of `incrementalTime` is Pacific Time. For EU Data Center customers, the time zone of `incrementalTime` is UTC. If the time zone of your system is different from the time zone of `incrementalTime`, you will need to convert to the appropriate time zone before setting `incrementalTime`.\n\n**Note**: This field can only be used in Stateful AQuA mode.\n"
},
"nullReplacement": {
"type": "string",
"description": "The string used to represent null values in the query results. If you do not set this parameter, null values are represented by the empty string in the query results.\n"
}
}
}
SubmitBatchQueryResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The job ID created for the AQuA API request. The job ID can be used for querying for the query status. \n\nThe ID exists only if the JSON request can be parsed and validated successfully. Otherwise, the job ID is null.\n"
},
"name": {
"type": "string",
"description": "The name of the job. 32 character limit.\n"
},
"format": {
"enum": [
"csv",
"zip",
"gzip"
],
"type": "string",
"description": "The format of the query. The default value is `csv`.\n"
},
"offset": {
"type": "integer",
"default": 0,
"description": "This field specifies the time offset for AQuA queries in stateful mode. It is an integer in the range 0 to 3,600 seconds.\n\nFor example, if you set this field to 600 seconds and you post a query in stateful mode at 2:00 AM, it will query against data created or updated between the completion time of the previous query and 1:50 AM.\n\nThe value of this field will override the value you configured in **Settings** > **Administration** > **AQuA API Stateful Mode Time Offset**. \n"
},
"status": {
"enum": [
"submitted",
"executing",
"completed",
"error",
"aborted",
"cancelled"
],
"type": "string",
"description": "The status of the AQuA job:\n- submitted: The AQuA job was submitted to the query executor for processing.\n- executing: The AQuA job is being processed.\n- completed: The AQuA job was successfully executed.\n- error: The AQuA job was not processed because of validation errors.\n- aborted: The AQuA job execution failed because one or more queries of this job failed.\n- cancelled: The AQuA job was cancelled.\n"
},
"batches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchesQueries"
},
"required": [
"name",
"query",
"status",
"batchId",
"batchType"
],
"description": "A JSON array object that contains a list of batch objects.\n"
},
"partner": {
"type": "string",
"description": "The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days.\n\nIt must be used together with \"project\" field to uniquely identify a data integration target.\n\nFor example, if a continuous AQuA session is to retrieve data incrementally for a Salesforce.com Org 00170000011K3Ub, you can use partner as \"Salesforce\", and \"project\" as \"00170000011K3Ub.\" \n\nThis field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.\n\n**Note**: Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Bulk_data__extraction_from_Zuora_using_AQuA\" target=\"_blank\">Bulk data extraction from Zuora using AQuA</a> for best practices.\n\n**Note**: Submit a request at <a href=\"http://support.zuora.com\" target=\"_blank\">Zuora Global Support</a> to obtain a partner ID.\n"
},
"project": {
"type": "string",
"description": "The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days.\n\nThis field must be used together with partner field to uniquely identify a data integration target. \n\nThis field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null.\n"
},
"version": {
"type": "number",
"format": "float",
"description": "The API version you want to use. \n\nThe supported versions are as follows:\n - `1.1`. It supports both modes\n - `1.0`. Default. It supports stateless modes only.\n\nSee <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/BA_Stateless_and_Stateful_Modes\" target=\"_blank\">Stateless and stateful modes</a> for more information.\n"
},
"encrypted": {
"enum": [
"pgp",
"none"
],
"type": "string",
"description": "If enabled, you must supply the formatting (zip or unzip) first and decrypt it to get the actual contents. \n"
},
"notifyUrl": {
"type": "string",
"description": "If URL is provided, the AQuA job will call this `notifyUrl` once the job has completed. The value of `notifyUrl` needs to have `${JOBID}` and `${STATUS}` placeholders. These placeholders will be replaced by the actual job ID and status when returned in the response. Status will be `Completed` after the AQuA job is done.\n\nIf you submit an AQuA query with `notifyUrl` specified, the value of `notifyUrl` will be ignored if your organization has already <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Callout_Notification_for_Completed_AQuA_Jobs\" target=\"_blank\">configured a callout notification through the Zuora user interface</a>. \n"
},
"sourceData": {
"type": "string",
"description": "Indicates the source this aggregate query runs against:\n\n* `LIVE` represents the live transactional databases at Zuora (Data Query Live).\n"
},
"incrementalTime": {
"type": "string",
"format": "dateTime",
"description": "Allows you to override the time from which a Stateful AQuA job incrementally retrieves records that have been created or modified, using the `incrementalTime` parameter. For example, if you set `incrementalTime` = `2015-01-21 10:30:01`, AQuA will retrieve records that have created or modified beginning at 10:30:01. If this parameter is not set, AQuA continues to use the Start Time of the last AQuA session to retrieve records incrementally.\n\nThe time zone of `incrementalTime` depends on which Zuora data center you use. For US Data Center customers, the time zone of `incrementalTime` is Pacific Time. For EU Data Center customers, the time zone of `incrementalTime` is UTC. If the time zone of your system is different from the time zone of `incrementalTime`, you will need to convert to the appropriate time zone before setting `incrementalTime`.\n\n**Note**: This field can only be used in Stateful AQuA mode. \n"
},
"useLastCompletedJobQueries": {
"type": "boolean",
"description": "If this flag is set to `true`, then all the previous queries are merged with existing queries.\n\nIf the flag is set to `false`, then the previous queries are ignored, and only the new query is executed.\n"
}
}
}
SubmitDataLabelingJobRequest
{
"type": "object",
"example": {
"query": "select Id from Account where BillToContact.Country = 'US'",
"orgIds": [
"12345678-1234-1234-1234-123456789012"
],
"queryType": "ByZoql",
"objectType": "Account"
},
"required": [
"objectType",
"queryType"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the objects to be labeled, only required if the `queryType` is `ById`.\n\nThere is a 4MB limit of the JSON payload, so in case of a large number of IDs, please make sure the payload is less than 4MB.\n"
},
"orgs": {
"type": "array",
"items": {
"type": "string"
},
"description": "The names of the organizations that the data labeling job will associate with the data to be labeled. Either the `orgIds` or `orgs` field is required.\n\nFor `Account` object, one and only one org name is required.\n\nFor configuration objects, `null` and `[]` are treated differently, use `null` to unlabel the object, `[]` to label it with all orgs.\n"
},
"query": {
"type": "string",
"description": "The query that the data labeling job will run to fetch the data to be labeled, only required if the `queryType` is `ByZoql`.\n"
},
"orgIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"maxLength": 36,
"minLength": 36
},
"format": "byte",
"description": "The IDs of the organizations that the data labeling job will associate with the data to be labeled. Either the `orgIds` or `orgs` field is required.\n\nFor `Account` object, one and only one org Id is required.\n\nFor configuration objects, `null` and `[]` are treated differently, use `null` to unlabel the object, `[]` to label it with all orgs.\n"
},
"queryType": {
"enum": [
"ByZoql",
"ById"
],
"type": "string",
"description": "Specifies the type of query that the data labeling job will run to fetch the data to be labeled.\n\n* `ByZoql` - The data labeling job will run a ZOQL query which is specified in the `query` field to fetch the data to be labeled.\n* `ById` - The data labeling job will fetch the data to be labeled by the IDs specified in the `ids` field.\n"
},
"objectType": {
"type": "string",
"description": "The object type of the data labeling job.\n\nCurrently, the following objects are supported:\n * `User`\n * `Account` \n\n All the associated transaction objects of the account being labeled will automatically inherit the org label of the account.\n * `Product`\n\n You have to label the Account object first, make sure all accounts have been labeled, then you can proceed with the Product object. \n\n You can get all the unlabeled accounts by running a Data Source export job, with the following query:\n ``` sql\n SELECT Id, Name FROM Account WHERE Organization.Id IS NULL\n ``` \n \n All the ProductRatePlanS of the product will be automatically labeled with the same `orgs`.\n \n When labeling products, you can omit the `orgs` parameter, i.e, leave it empty, the system will find all the subscriptions that include the product and get the org list of those subscriptions, then label the product with those `orgs`, aka, the `derived orgs`.\n \n You can also explicitly specify the orgs parameter, in that case, you will need to provide a super set of the `derived orgs`. \n * `BillRun`\n\n You don't need to specify the `orgs` parameter, we will label the `BillRun` with all the orgs because existing runs could pick up all accounts. You can definitely create new bill run with certain `orgs` to operate separately by `orgs`.\n * `PaymentRun`\n\n Same as BillRun.\n * `ForecastRun`\n"
}
}
}
SubmitDataLabelingJobResponse
{
"type": "object",
"properties": {
"jobId": {
"type": "string",
"format": "uuid",
"maxLength": 32,
"minLength": 32,
"description": "Identifier of the data labeling job.\n"
},
"success": {
"type": "boolean",
"description": "Indicates whether the job was submitted successfully.\n"
},
"jobStatus": {
"enum": [
"Accepted",
"Dispatched",
"Completed"
],
"type": "string",
"description": "Status of the data labeling job.\n\n* `Accepted` - The data labeling job has been accepted by the system.\n* `Dispatched` - The data labeling job is dispatched to the data labeling service.\n* `Completed` - The data labeling job has completed. Please note that `Completed` simply means the data labeling job has completed, but it does not mean the data labeling job has labeled all the data. You can check the `progress` field to see how many data have been `labeled`, `failed` or `timeout`.\n"
}
}
}
SubmitDataQueryRequest
{
"type": "object",
"example": {
"query": "SELECT accountnumber, balance FROM Account WHERE Account.balance > 100",
"output": {
"target": "S3"
},
"sourceData": "LIVE",
"compression": "NONE",
"outputFormat": "JSON"
},
"required": [
"query",
"outputFormat",
"compression",
"output"
],
"properties": {
"query": {
"type": "string",
"description": "The query to perform. See [SQL Queries in Data Query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query/BA_SQL_Queries_in_Data_Query) for more information.\n"
},
"output": {
"type": "object",
"required": [
"target"
],
"properties": {
"target": {
"enum": [
"S3"
],
"type": "string",
"description": "Set this field to `S3`.\n"
}
},
"description": "Additional information about the query results.\n"
},
"sourceData": {
"enum": [
"LIVE",
"WAREHOUSE"
],
"type": "string",
"description": "Specify the source that data queries run against:\n\n* `LIVE` represents the live transactional databases at Zuora (Data Query Live).\n\n* `WAREHOUSE` represents Zuora Warehouse, which has better performance and fewer limitations than the live transactional database. This option is available only if you have the Zuora Warehouse feature enabled in your tenant. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_Warehouse/A_Zuora_Warehouse_overview\" target=\"_blank\">Zuora Warehouse</a>. <br>If this option is selected, you can specify warehouse size in `warehouseSize`.\n\nIf this field is not specified, the default value `LIVE` will be used.\n"
},
"compression": {
"enum": [
"NONE",
"GZIP",
"ZIP"
],
"type": "string",
"description": "Specifies whether Zuora compresses the query results.\n"
},
"readDeleted": {
"type": "boolean",
"default": false,
"description": "Indicates whether the query will retrieve only the deleted record. If `readDeleted` is set to `false` or it is not included in the request body, the query will retrieve only the non-deleted records. If it is set to `true`, only the deleted records will be retrieved.\n\nIf you select the `deleted` column in the `query` field, both non-deleted and deleted records will be retrieved regardless of the value in the `readDeleted` field.\n\nNote that Data Query is subject to Zuora Data Retention Policy. The retention period of deleted data is 30 days. You can only retrieve deleted data for 30 days through Data Query.\n"
},
"outputFormat": {
"enum": [
"JSON",
"CSV",
"TSV",
"DSV"
],
"type": "string",
"description": "Specifies the format of the query results.\n\n* `JSON` - Each row in the query results will be a JSON object. The format of the query result file is [JSON Lines](http://jsonlines.org/).\n* `CSV` - Each row in the query results will be a comma-separated list of values.\n* `TSV` - Each row in the query results will be a tab-separated list of values.\n* `DSV` - Pass any character as your custom delimiter into the `columnSeparator` field.\n"
},
"useIndexJoin": {
"type": "boolean",
"description": "Indicates whether to use Index Join. Index join is useful when you have a specific reference value in your WHERE clause to index another large table by. See [Use Index Join](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query/Best_practices_of_Data_Query#Use_Index_Join) for more information."
},
"encryptionKey": {
"type": "string",
"format": "byte",
"description": "Base-64 encoded public key of an RSA key-pair. \n\nNote that Data Query only supports 1024-bit RSA keys.\n\nIf you set this field, Zuora encrypts the query results using the provided public key. You must use the corresponding private key to decrypt the query results.\n"
},
"warehouseSize": {
"enum": [
"xsmall",
"NULL"
],
"type": "string",
"description": "Specify the size of Zuora Warehouse. This field is available only if the `sourceData` is `WAREHOUSE`.\n\nIf this field is not specified or set to `NULL`, the default value `xsmall` will be used.\n"
},
"columnSeparator": {
"type": "string",
"description": "The column separator. Only applicable if the `outputFormat` is `DSV`.\n"
}
}
}
SubmitDataQueryResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DataQueryJob"
}
}
}
SubscriptionData
{
"type": "object",
"properties": {
"notes": {
"type": "string",
"maxLength": 500,
"description": "Notes about the subscription. These notes are only visible to Zuora users.\n"
},
"terms": {
"$ref": "#/components/schemas/TermInfo"
},
"ratePlans": {
"$ref": "#/components/schemas/RatePlans"
},
"startDate": {
"type": "string",
"format": "date"
},
"customFields": {
"$ref": "#/components/schemas/CustomFields"
},
"invoiceSeparately": {
"type": "boolean",
"description": "Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.\n"
},
"subscriptionNumber": {
"type": "string",
"maxLength": 100,
"description": "Subscription number of the subscription to create, for example, A-S00000001.\n\nIf you do not set this field, Zuora will generate a subscription number.\n"
}
}
}
SubscriptionObjectCustomFields
{
"type": "object",
"title": "subscriptionFieldsCustom",
"description": "Container for custom fields of a Subscription object.\n",
"additionalProperties": {
"description": "Custom fields of the Subscription object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
SubscriptionObjectNSFields
{
"type": "object",
"title": "subscriptionFieldsNS",
"properties": {
"Project__NS": {
"type": "string",
"maxLength": 255,
"description": "The NetSuite project that the subscription was created from. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"SyncDate__NS": {
"type": "string",
"maxLength": 255,
"description": "Date when the subscription was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"SalesOrder__NS": {
"type": "string",
"maxLength": 255,
"description": "The NetSuite sales order than the subscription was created from. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationId__NS": {
"type": "string",
"maxLength": 255,
"description": "ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
},
"IntegrationStatus__NS": {
"type": "string",
"maxLength": 255,
"description": "Status of the subscription's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
},
"description": "Container for Subscription fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).\n"
}
SubscriptionObjectQTFields
{
"type": "object",
"title": "subscriptionFieldsQT",
"properties": {
"QuoteType__QT": {
"type": "string",
"maxLength": 32,
"description": "The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n"
},
"QuoteNumber__QT": {
"type": "string",
"maxLength": 32,
"description": "The unique identifier of the Quote. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n"
},
"CpqBundleJsonId__QT": {
"type": "string",
"maxLength": 32,
"description": "The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.\n"
},
"OpportunityName__QT": {
"type": "string",
"maxLength": 100,
"description": "The unique identifier of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n"
},
"QuoteBusinessType__QT": {
"type": "string",
"maxLength": 32,
"description": "The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n"
},
"OpportunityCloseDate__QT": {
"type": "string",
"format": "date",
"description": "The closing date of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n"
}
},
"description": "Container for Subscription fields provided by Zuora Quotes.\n"
}
SystemHealthErrorResponse
{
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The system health api path having error.\n"
},
"error": {
"type": "string",
"description": "Error status text.\n"
},
"status": {
"type": "integer",
"description": "Error status code.\n"
},
"message": {
"type": "string",
"description": "The associated reason.\n"
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "The time when error happens.\n"
}
}
}
Task
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the task.\n"
},
"data": {
"type": "object",
"description": "The data payload for the task.\n"
},
"name": {
"type": "string",
"description": "The name of the task.\n"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The array of filter tags.\n"
},
"error": {
"type": "string",
"description": "If **Instance** is **true** and **status** is **Error**, the error reason of the task instance failure.\n"
},
"object": {
"type": "string",
"description": "The selected object for the task.\n"
},
"status": {
"enum": [
"Queued",
"Processing",
"Pending",
"Success",
"Stopped",
"Error"
],
"type": "string",
"description": "If **Instance** is **true**, the status of the task instance.\n"
},
"task_id": {
"type": "integer",
"description": "the id of this task's parent task. Will be null if this is the first task of the workflow"
},
"end_time": {
"type": "string",
"description": "If **Instance** is **true**, the end time of the task instance.\n"
},
"instance": {
"type": "boolean",
"description": "Indicates whether this task belongs to an instance of a workflow.\n"
},
"call_type": {
"type": "string",
"description": "The type of API used.\n"
},
"object_id": {
"type": "string",
"description": "The id of the selected object of the task.\n"
},
"parameters": {
"type": "object",
"description": "The configuration of the task.\n"
},
"start_time": {
"type": "string",
"description": "If **Instance** is **true**, the start time of the task instance.\n"
},
"action_type": {
"enum": [
"Approval",
"Attachment",
"Billing::BillRun",
"Billing::CurrencyConversion",
"Billing::CustomInvoice",
"Callout",
"Cancel",
"Create",
"CustomObject::Create",
"CustomObject::Delete",
"CustomObject::Query",
"CustomObject::Update",
"Data::BillingPreviewRun",
"Data::Link",
"Delay",
"Delete",
"Download::SFTP",
"Email",
"Export",
"File::CustomPDF::CustomDocument",
"If",
"InvoiceGenerate",
"Iterate",
"Logic::CSVTranslator",
"Logic::Case",
"Logic::CustomCode",
"Logic::JSONTransform",
"Logic::Lambda",
"Logic::ResponseFormatter",
"Logic::XMLTransform",
"NewProduct",
"Notifications::GoogleCloudPrint",
"Notifications::PhoneCall",
"Notifications::SMS",
"Payment::GatewayReconciliation",
"Payment::PaymentRun",
"Query",
"RemoveProduct",
"Reporting::ReportData",
"Reporting::RunReport",
"Resume",
"Suspend",
"UI::Page",
"UI::Stop",
"Update",
"Upload::FTP",
"Upload::SFTP",
"WriteOff"
],
"type": "string",
"description": "The type of the task.\n"
},
"error_class": {
"type": "string",
"description": "If **Instance** is **true** and **status** is **Error**, the error class of the task instance failure.\n"
},
"workflow_id": {
"type": "integer",
"description": "The ID of the workflow that the task belongs to.\n"
},
"error_details": {
"type": "string",
"description": "If **Instance** is **true** and **status** is **Error**, the error details of the task instance failure.\n"
},
"concurrent_limit": {
"type": "integer",
"description": "the number of concurrent tasks that are allowed to run simultaneously"
},
"original_task_id": {
"type": "integer",
"description": "If **Instance** is **true**, the ID of the original task in the original workflow.\n"
},
"original_workflow_id": {
"type": "integer",
"description": "If **Instance** is **true**, the ID of the original workflow.\n"
}
},
"description": "A task.\n"
}
TasksResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Task"
},
"description": "The list of tasks retrieved.\n"
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"description": "An integer denoting the current page number.\n"
},
"next_page": {
"type": "string",
"description": "A string containing the URL where the next page of data can be retrieved.\n"
},
"page_length": {
"type": "integer",
"description": "An integer denoting the number of tasks in this response. The maximum value is 100.\n"
}
},
"description": "An object containing pagination information for the list of tasks returned by the API.\n"
}
}
}
TaxInfo
{
"type": "object",
"title": "taxInfo",
"properties": {
"VATId": {
"type": "string",
"maxLength": 25,
"description": "EU Value Added Tax ID.\n\n**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com).\n"
},
"companyCode": {
"type": "string",
"maxLength": 50,
"description": "Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara.\n\n**Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com).\n"
},
"exemptStatus": {
"enum": [
"No",
"Yes",
"PendingVerification"
],
"type": "string",
"default": "No",
"description": "Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax. \n"
},
"exemptDescription": {
"type": "string",
"maxLength": 500,
"description": "Description of the tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"exemptCertificateId": {
"type": "string",
"maxLength": 32,
"description": "ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"exemptEffectiveDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption starts, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"exemptExpirationDate": {
"type": "string",
"format": "date",
"description": "Date when the customer tax exemption expires, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"exemptCertificateType": {
"type": "string",
"maxLength": 32,
"description": "Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.\n"
},
"exemptIssuingJurisdiction": {
"type": "string",
"maxLength": 32,
"description": "Jurisdiction in which the customer tax exemption certificate was issued.\n"
}
},
"description": "Information about the tax exempt status of a customer account.\n"
}
TaxationItemObjectCustomFields
{
"type": "object",
"title": "taxationItemFieldsCustom",
"description": "Container for custom fields of a Taxation Item object.\n",
"additionalProperties": {
"description": "Custom fields of the Taxation Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
TemplateDetailResponse
{
"type": "object",
"title": "TemplateDetailResponse",
"properties": {
"id": {
"type": "string",
"description": "Id of the template."
},
"name": {
"type": "string",
"description": "Name of the template."
},
"active": {
"type": "boolean",
"description": "Whether or not the template is active."
},
"errors": {
"type": "string",
"description": "Error information."
},
"status": {
"type": "string",
"description": "The status of the template creation, such as whether it is in progress, completed, or failed."
},
"content": {
"$ref": "#/components/schemas/SettingSourceComponentResponse"
},
"createdBy": {
"type": "string",
"description": "Information about the user who created it."
},
"createdOn": {
"type": "string",
"description": "When it is created."
},
"entityName": {
"type": "string",
"description": "Name of the Entity"
},
"tenantName": {
"type": "string",
"description": "Tenant's name for whom the template is created."
},
"description": {
"type": "string",
"description": "Template description which contains the information about the created template."
},
"environment": {
"type": "string",
"description": "Details of the environment in which the template was created."
}
},
"description": "Contains all template details."
}
TemplateMigrationClientRequest
{
"type": "object",
"title": "TemplateMigrationClientRequest",
"required": [
"description",
"entityUuid",
"name",
"sendEmail"
],
"properties": {
"name": {
"type": "string",
"example": "Job A",
"description": "Name of the migration."
},
"request": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MigrationComponentContent"
},
"example": "ST 4",
"description": "List of settings need to be migrated."
},
"comments": {
"type": "string"
},
"emailIds": {
"type": "string",
"example": "abcd@zuora.com,xyz@zuora.com",
"description": "List of Emails with comma separator."
},
"metaData": {
"$ref": "#/components/schemas/JsonNode"
},
"sendEmail": {
"type": "boolean",
"example": true,
"description": "Flag determines whether or not to send an email."
},
"entityUuid": {
"type": "string",
"example": 11111,
"description": "Entity UUID"
},
"description": {
"type": "string",
"example": "Migration from/to Sandbox",
"description": "Description of the migration."
}
},
"description": "Request to add a new Template migration.\nTemplateMigrationClientRequest object contains request details of target tenant, source tenant, and template information needed for migration.\n"
}
TemplateResponse
{
"type": "object",
"title": "TemplateResponse",
"properties": {
"templates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateDetailResponse"
},
"description": "Contains list of template details."
}
},
"description": "It contains a collection of all the templates that have been created."
}
TermInfo
{
"type": "object",
"required": [
"initialTerm"
],
"properties": {
"autoRenew": {
"type": "boolean",
"description": "Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is `TERMED`.\n"
},
"initialTerm": {
"$ref": "#/components/schemas/TermInfo_initialTerm"
},
"renewalTerms": {
"$ref": "#/components/schemas/TermInfo_renewalTerms"
},
"renewalSetting": {
"enum": [
"RENEW_WITH_SPECIFIC_TERM",
"RENEW_TO_EVERGREEN"
],
"type": "string",
"description": "Specifies the type of the terms that follow the first term if the subscription is renewed. Only applicable if the type of the first term is `TERMED`.\n\n* `RENEW_WITH_SPECIFIC_TERM` - Each renewal term has a predefined duration. The first entry in `renewalTerms` specifies the duration of the second term of the subscription, the second entry in `renewalTerms` specifies the duration of the third term of the subscription, and so on. The last entry in `renewalTerms` specifies the ultimate duration of each renewal term.\n* `RENEW_TO_EVERGREEN` - The second term of the subscription does not have a predefined duration.\n"
}
},
"description": "Container for the terms and renewal settings of the subscription.\n"
}
TermInfo_initialTerm
{
"type": "object",
"required": [
"termType"
],
"properties": {
"period": {
"type": "integer",
"description": "Duration of the first term in months, years, days, or weeks, depending on the value of the `periodType` field. Only applicable if the value of the `termType` field is `TERMED`.\n"
},
"termType": {
"enum": [
"TERMED",
"EVERGREEN"
],
"type": "string",
"description": "Type of the first term. If the value of this field is `TERMED`, the first term has a predefined duration based on the value of the `period` field. If the value of this field is `EVERGREEN`, the first term does not have a predefined duration.\n"
},
"startDate": {
"type": "string",
"format": "date",
"description": "Start date of the first term, in YYYY-MM-DD format.\n"
},
"periodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"description": "Unit of time that the first term is measured in. Only applicable if the value of the `termType` field is `TERMED`.\n"
}
},
"description": "Information about the first term of the subscription.\n"
}
TermInfo_renewalTerms
{
"type": "object",
"properties": {
"period": {
"type": "integer",
"description": "Duration of the renewal term in months, years, days, or weeks, depending on the value of the `periodType` field.\n"
},
"periodType": {
"enum": [
"Month",
"Year",
"Day",
"Week"
],
"type": "string",
"description": "Unit of time that the renewal term is measured in.\n"
}
}
}
TermsAndConditions
{
"type": "object",
"title": "termsAndConditions",
"properties": {
"autoRenew": {
"type": "boolean"
},
"initialTerm": {
"$ref": "#/components/schemas/InitialTerm"
},
"paymentTerm": {
"type": "string",
"description": "The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"renewalTerms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RenewalTerm"
}
},
"sequenceSetId": {
"type": "string",
"description": "The ID of the sequence set associated with the subscription.\n \n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"renewalSetting": {
"enum": [
"RENEW_WITH_SPECIFIC_TERM",
"RENEW_TO_EVERGREEN"
],
"type": "string"
},
"billToContactId": {
"type": "string",
"description": "The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"soldToContactId": {
"type": "string",
"description": "The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceTemplateId": {
"type": "string",
"description": "The ID of the invoice template associated with the subscription.\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"invoiceGroupNumber": {
"type": "string",
"nullable": true,
"maxLength": 255,
"description": "The number of the invoice group associated with the subscription.\n\nAfter enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).\n\n**Note**: \n - If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.\n"
},
"clearingExistingPaymentTerm": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingSequenceSet": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingBillToContact": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingSoldToContact": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingInvoiceTemplate": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
},
"clearingExistingInvoiceGroupNumber": {
"type": "boolean",
"default": false,
"description": "Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body.\n"
}
},
"description": "Information about an order action of type `TermsAndConditions`.\n"
}
TimeSlicedElpNetMetrics
{
"type": "object",
"properties": {
"tax": {
"type": "number",
"description": "The tax amount in the metric when the tax permission is enabled."
},
"type": {
"enum": [
"Regular",
"Discount"
],
"type": "string",
"description": "The type for ELP is always \"Regular\"."
},
"amount": {
"type": "number",
"description": "The extended list price which is calculated by the original product catalog list price multiplied by the delta quantity."
},
"endDate": {
"type": "string",
"format": "date",
"description": "The latest date that the metric applies."
},
"startDate": {
"type": "string",
"format": "date",
"description": "The earliest date that the metric applies."
},
"termNumber": {
"type": "number",
"format": "long"
},
"orderItemId": {
"type": "string",
"description": "The ID of the order item referenced by the order metrics."
},
"invoiceOwner": {
"type": "string",
"description": "The acount number of the billing account that is billed for the subscription."
},
"generatedReason": {
"enum": [
"IncreaseQuantity",
"DecreaseQuantity",
"ChangePrice",
"Extension",
"Contraction"
],
"type": "string",
"description": "Specify the reason why the metrics are generated by the certain order action.\n"
},
"subscriptionOwner": {
"type": "string",
"description": "The acount number of the billing account that owns the subscription."
}
}
}
TimeSlicedMetrics
{
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"endDate": {
"type": "string",
"format": "date"
},
"startDate": {
"type": "string",
"format": "date"
},
"termNumber": {
"type": "number",
"format": "long"
},
"orderItemId": {
"type": "string",
"description": "The ID of the order item referenced by the order metrics.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
},
"invoiceOwner": {
"type": "string",
"description": "The acount number of the billing account that is billed for the subscription."
},
"generatedReason": {
"enum": [
"IncreaseQuantity",
"DecreaseQuantity",
"ChangePrice",
"Extension",
"Contraction"
],
"type": "string",
"description": "Specify the reason why the metrics are generated by the certain order action.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
},
"subscriptionOwner": {
"type": "string",
"description": "The acount number of the billing account that owns the subscription."
}
}
}
TimeSlicedNetMetrics
{
"type": "object",
"properties": {
"type": {
"enum": [
"Regular",
"Discount"
],
"type": "string",
"description": "Indicates whether this metrics is for a regular charge or a discount charge."
},
"amount": {
"type": "number"
},
"endDate": {
"type": "string",
"format": "date"
},
"startDate": {
"type": "string",
"format": "date"
},
"termNumber": {
"type": "number",
"format": "long"
},
"orderItemId": {
"type": "string",
"description": "The ID of the order item referenced by the order metrics.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
},
"invoiceOwner": {
"type": "string",
"description": "The acount number of the billing account that is billed for the subscription."
},
"generatedReason": {
"enum": [
"IncreaseQuantity",
"DecreaseQuantity",
"ChangePrice",
"Extension",
"Contraction"
],
"type": "string",
"description": "Specify the reason why the metrics are generated by the certain order action.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
},
"subscriptionOwner": {
"type": "string",
"description": "The acount number of the billing account that owns the subscription."
},
"discountChargeNumber": {
"type": "string"
}
}
}
TimeSlicedTcbNetMetrics
{
"type": "object",
"properties": {
"tax": {
"type": "number"
},
"type": {
"enum": [
"Regular",
"Discount"
],
"type": "string",
"description": "Indicates whether this metrics is for a regular charge or a discount charge."
},
"amount": {
"type": "number"
},
"endDate": {
"type": "string",
"format": "date"
},
"startDate": {
"type": "string",
"format": "date"
},
"termNumber": {
"type": "number",
"format": "long"
},
"orderItemId": {
"type": "string",
"description": "The ID of the order item referenced by the order metrics.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
},
"invoiceOwner": {
"type": "string",
"description": "The acount number of the billing account that is billed for the subscription."
},
"generatedReason": {
"enum": [
"IncreaseQuantity",
"DecreaseQuantity",
"ChangePrice",
"Extension",
"Contraction"
],
"type": "string",
"description": "Specify the reason why the metrics are generated by the certain order action.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
},
"subscriptionOwner": {
"type": "string",
"description": "The acount number of the billing account that owns the subscription."
},
"discountChargeNumber": {
"type": "string"
}
}
}
TransferPaymentType
{
"type": "object",
"example": {
"accountId": "4028905f5a87c0ff015a88889fe500a8"
},
"properties": {
"accountId": {
"type": "string",
"description": "The ID of the customer account that the payment is transferred to.\nUnassign a payment by setting this field to an empty string. This will automatically transfer the payment to a null account.\n"
}
}
}
TriggerDate
{
"type": "object",
"title": "triggerDate",
"properties": {
"name": {
"enum": [
"ContractEffective",
"ServiceActivation",
"CustomerAcceptance"
],
"type": "string",
"description": "Name of the trigger date of the order action.\n"
},
"triggerDate": {
"type": "string",
"format": "date",
"description": "Trigger date in YYYY-MM-DD format.\n"
}
}
}
TriggerParams
{
"type": "object",
"title": "startDate",
"properties": {
"triggerEvent": {
"enum": [
"ContractEffective",
"ServiceActivation",
"CustomerAcceptance",
"SpecificDate"
],
"type": "string",
"description": "Condition for the charge to become active.\n\nIf the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.\n"
},
"startDatePolicy": {
"enum": [
"AlignToApplyToCharge",
"SpecificDate",
"EndOfLastInvoicePeriodOfApplyToCharge",
"FixedPeriodAfterApplyToChargeStartDate"
],
"type": "string",
"description": "Start date policy of the discount charge to become active when the **Apply to billing period partially** checkbox is selected from the product catalog UI or the `applyToBillingPeriodPartially` field is set as true from the \"CRUD: Create a product rate plan charge\" operation. \n\n- If the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.\n- If the value of this field is `FixedPeriodAfterApplyToChargeStartDate`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields.\n\n**Notes**: \n - You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field. \n - You can use either `triggerEvent` or `startDatePolicy` to define when a discount charge starts, but not both at the same time.\n"
},
"startPeriodsType": {
"enum": [
"Days",
"Weeks",
"Months",
"Years"
],
"type": "string",
"description": "Unit of time that the discount charge duration is measured in. Only applicable if the value of the `startDatePolicy` field is `FixedPeriodAfterApplyToChargeStartDate`.\n\n**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.\n"
},
"specificTriggerDate": {
"type": "string",
"format": "date",
"description": "Date in YYYY-MM-DD format. Only applicable if the value of the `triggerEvent` field is `SpecificDate`. \n\nWhile this field is applicable, if this field is not set, your `CreateSubscription` order action creates a `Pending` order and a `Pending Acceptance` subscription. If at the same time the service activation date is required and not set, a `Pending Activation` subscription is created.\n\nWhile this field is applicable, if this field is not set, the following order actions create a `Pending` order but do not impact the subscription status. **Note**: This feature is in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n"
},
"periodsAfterChargeStart": {
"type": "integer",
"description": "Duration of the discount charge in days, weeks, months, or years, depending on the value of the `startPeriodsType` field. Only applicable if the value of the `startDatePolicy` field is `FixedPeriodAfterApplyToChargeStartDate`.\n\n**Note**: You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field.\n"
}
},
"description": "Specifies when a charge becomes active.\n"
}
UnapplyCreditMemoType
{
"type": "object",
"example": {
"invoices": [
{
"items": [
{
"amount": 0.9,
"invoiceItemId": "4028905f5a87c0ff015a87d3f90c0045",
"creditMemoItemId": "4028905f5a890526015a8d73f74b0016"
},
{
"amount": 0.1,
"taxItemId": "4028905f5a87c0ff015a87d3f884003f",
"creditTaxItemId": "4028905f5a890526015a8d73f90c0018"
}
],
"amount": 1,
"invoiceId": "4028905f5a87c0ff015a87d3f8f10043"
}
],
"effectiveDate": "2017-03-02"
},
"properties": {
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoUnapplyInvoiceRequestType"
},
"description": "Container for invoices that the credit memo is unapplied from. The maximum number of invoices is 1,000.\n"
},
"debitMemos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditMemoUnapplyDebitMemoRequestType"
},
"description": "Container for debit memos that the credit memo is unapplied from. The maximum number of debit memos is 1,000.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the credit memo is unapplied.\n"
}
}
}
UnapplyPaymentType
{
"type": "object",
"example": {
"invoices": [
{
"items": [
{
"amount": 10,
"invoiceItemId": "4028905f5a87c0ff015a87d3f90c0045"
},
{
"amount": 0.1,
"taxItemId": "4028905f5a87c0ff015a87d3f884003f"
}
],
"amount": 10.1,
"invoiceId": "4028905f5a87c0ff015a87d3f8f10043"
}
],
"debitMemos": [
{
"items": [
{
"amount": 1,
"debitMemoItemId": "4028905f5a87c0ff015a87e49e7a0063"
},
{
"amount": 0.02,
"taxItemId": "4028905f5a87c0ff015a87e49f5e0065"
}
],
"amount": 1.02,
"debitMemoId": "4028905f5a87c0ff015a87e49e6b0062"
}
],
"effectiveDate": "2017-03-01"
},
"properties": {
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentInvoiceApplicationUnapplyRequestType"
},
"description": "Container for invoices. The maximum number of invoice is 1,000.\n"
},
"debitMemos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentDebitMemoApplicationUnapplyRequestType"
},
"description": "Container for debit memos. The maximum number of debit memos is 1,000.\n"
},
"effectiveDate": {
"type": "string",
"format": "date",
"description": "The date when the payment is unapplied, in `yyyy-mm-dd` format. The effective date must be later than or equal to the maximum effective date of the payment.\n"
}
}
}
UpdateCustomObjectCusotmField
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom field to be updated"
},
"unique": {
"type": "boolean",
"description": "Indicates whether to specify a unique constraint to the field. You can remove the unique constraint on the field. However, you can only add a unique constraint to a filterable field if the custom object contains no record. One custom object can have a maximum of five fields with unique constraints.\n"
},
"required": {
"type": "boolean",
"description": "Indicates whether the field is required or optional.\n\nYou can update a required field to optional. On the other hand, you can only update an optional field to required on the custom object with no records.\n\nYou can only add a required field to the custom object with no records.\n"
},
"auditable": {
"type": "boolean",
"description": "Indicates whether Audit Trail will record changes of this custom field. You can change auditable fields to non-auditable, and vice versa. One custom object can have a maximum of five auditable fields.\n"
},
"definition": {
"$ref": "#/components/schemas/CustomObjectCustomFieldDefinitionUpdate"
},
"filterable": {
"type": "boolean",
"description": "Indicates whether the field is filterable or not. Applicable to `addField` and `updateField` actions.\n\nYou can change a filterable field to non-filterable and vice versa. You can also add a filterable field. One custom object can have a maximum of 10 filterable fields.\n\nNote that changing filterable fields triggers reindexing. It will take 12-24 hours before all your data are reindexed and available to query.\n"
},
"targetName": {
"type": "string",
"description": "Required if the `type` of the action is `renameField`"
}
},
"description": "A reference to a field."
}
UpdateEInvoiceFileTemplateRequest
{
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the e-invoice file template.\n"
},
"content": {
"type": "string",
"description": "The content of the e-invoice file template, which must be encoded in Base64 format.\n"
},
"country": {
"type": "string",
"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 <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions\" target=\"_blank\">View countries or regions</a>.\n"
},
"provider": {
"enum": [
"Sovos"
],
"type": "string",
"description": "The name of an e-invoicing service provider that assists in generating e-invoice files.\n"
},
"documentType": {
"enum": [
"Invoice",
"CreditMemo",
"DebitMemo"
],
"type": "string",
"description": "The type of billing documents, which the e-invoice file template is intended for.\n"
}
}
}
],
"example": {
"name": "Sovos e-invoice service",
"content": "base64 encoded content",
"country": "IN",
"provider": "Sovos",
"documentType": "Invoice"
}
}
UpdateEInvoicingBusinessRegionRequest
{
"allOf": [
{
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The the name of the city where the business is located.\n"
},
"email": {
"type": "string",
"description": "The email address of the Seller contact to receive e-invoicing data.\n"
},
"state": {
"type": "string",
"description": "The name of the state or province where the business is located.\n"
},
"country": {
"type": "string",
"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 <a href=\"https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions\" target=\"_blank\">View countries or regions</a>.\n"
},
"tradeName": {
"type": "string",
"maxLength": 100,
"description": "The name that the Seller is known as, other than the legal business name.\n"
},
"endpointId": {
"type": "string",
"description": "The Seller's electronic address, to which the application-level response to the e-invoice file might be delivered.\n"
},
"postalCode": {
"type": "string",
"description": "The short code that can identify the business address.\n"
},
"contactName": {
"type": "string",
"maxLength": 255,
"description": "The name of the Seller contact to receive e-invoicing data.\n"
},
"phoneNumber": {
"type": "string",
"description": "The business phone number of the Seller contact to receive e-invoicing data.\n"
},
"addressLine1": {
"type": "string",
"description": "The first line of the Seller’s address, which is often a street address or business name.\n"
},
"addressLine2": {
"type": "string",
"description": "The second line of the Seller’s address, which is often the name of a building.\n"
},
"businessName": {
"type": "string",
"maxLength": 255,
"description": "The full official name that the Seller is registered with the relevant legal authority.\n"
},
"businessNumber": {
"type": "string",
"description": "The specify the unique identifier number of the legal entity or person that you do business with.\n\nFor example, you must use a GSTIN for India and Tax Identification Number (TIN) for Saudi Arabia.\n"
},
"responseMapping": {
"type": "object",
"title": "responseMapping",
"description": "Container for e-invoicing response field mappings that map values from Sovos response data to fields on the EInvoiceData object in Zuora. Each response field mapping consists of a field name and a field path.\n\nNote that this field is applicable only to the Sovos service provider.\n\nFor more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings\" target=\"_blank\">Configure e-invoicing response field mappings</a>.\n",
"additionalProperties": {
"type": "string",
"description": "The response field mapping consists of a key-value pair:\n\n* Field name: the name of the field on the EInvoiceData object (except for the `EInvoiceFile` field). <br>Zuora supports the following field names. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Supported_response_fields\" target=\"_blank\">Supported response fields</a>.\n * `AuthorizationCode`\n * `EInvoiceFile`\n * `QrCode`\n * `ReferenceNumber`\n * `Field1` to `Field10`\n\n* Field value: the path of an XML node in the e-invoicing response data from Sovos. The value of this field must be compliant with the <a href=\"https://www.w3schools.com/xml/xpath_intro.asp\" target=\"_blank\">XPath</a> syntax. For more information, see <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Field_path_format\" target=\"_blank\">Field path format</a>.\n"
}
},
"endpointSchemeId": {
"type": "string",
"description": "The identification scheme identifier of the Seller’s electronic address.\n"
},
"serviceProviderId": {
"type": "string",
"description": "The unique ID of the e-invoicing service provider that is associated to the business region.\n"
},
"taxRegisterNumber": {
"type": "string",
"description": "The Seller's VAT identifier (also known as Seller VAT identification number) or the local identification (defined by the Seller’s address) of the Seller for tax purposes, or a reference that enables the Seller to state the registered tax status.\n"
},
"businessNumberSchemaId": {
"type": "string",
"description": "The identification scheme identifier that an official registrar issues to identify the Seller as a legal entity or person.\n"
},
"digitalSignatureEnable": {
"type": "boolean",
"default": false,
"description": "Whether the e-invoicing service provider signs PDF files for billing documents.\n"
},
"digitalSignatureBoxPosX": {
"type": "number",
"minimum": 0,
"description": "The X-coordinate to determine where the digital signature box is displayed on PDF files for billing documents.\n"
},
"digitalSignatureBoxPosY": {
"type": "number",
"minimum": 0,
"description": "The Y-coordinate to determine where the digital signature box is displayed on PDF files for billing documents. \n"
},
"digitalSignatureBoxEnable": {
"type": "boolean",
"default": false,
"description": "Whether the digital signature box is displayed on PDF files for billing documents.\n"
}
}
}
],
"example": {
"city": "Tokyo",
"email": null,
"state": null,
"country": "JP",
"tradeName": "Zuora",
"endpointId": "8992",
"postalCode": "368779",
"contactName": null,
"phoneNumber": null,
"addressLine1": null,
"addressLine2": null,
"businessName": "legal business name",
"businessNumber\"": "20002039",
"endpointSchemeId": "88",
"serviceProviderId": "4028948972a2bf990172bc9b27724ddc",
"taxRegisterNumber": "TAX393999",
"businessNumberSchemaId": "88"
}
}
UpdateEInvoicingServiceProviderRequest
{
"allOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 100,
"description": "The name of the e-invoicing service provider.\n"
},
"test": {
"type": "boolean",
"description": "Whether the e-invoicing service provider's configuration is intended for testing. \n\n- If you set this field to `true`, requests are directed to the testing integration endpoints.\n- If you set this field to `false`, requests are directed to the production integration endpoints.\n"
},
"apiKey": {
"type": "string",
"description": "The API key is used to authenticate the e-invoicing service provider's requests.\n"
},
"secretKey": {
"type": "string",
"description": "The secret key is used to authenticate the e-invoicing service provider's requests.\n"
},
"clientCertificate": {
"type": "string",
"format": "byte",
"description": "The client certificate is used to authenticate the e-invoicing service provider's requests, which should be in base64 encoded format.\n"
},
"companyIdentifier": {
"type": "string",
"description": "The identifier of the company used to create a sender system ID, which serves to identify the system where the transactions are sent.\n"
},
"clientCertificateType": {
"type": "string",
"default": "PKCS12",
"description": "The client certificate type is used to specify the type of the client certificate. \n"
},
"clientCertificatePassword": {
"type": "string",
"format": "password",
"description": "The client certificate password is the password to protect the client certificate.\n"
}
}
}
],
"example": {
"name": "Sovos e-invoice service",
"test": false,
"apiKey": "ApiKeySample",
"secretKey": "SecretKey",
"clientCertificate": "U3dhZ2dlciByb2Nrcw==",
"companyIdentifier": "CompanySample1",
"clientCertificateType": "PKCS12",
"clientCertificatePassword": "ClientCertificatePassword"
}
}
UpdatePaymentType
{
"allOf": [
{
"type": "object",
"properties": {
"comment": {
"type": "string",
"maxLength": 255,
"minLength": 0,
"description": "Comments about the payment.\n"
},
"referenceId": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.\n\nYou can only update the reference ID for external payments.\n"
},
"gatewayState": {
"enum": [
"NotSubmitted",
"Submitted",
"Settled",
"FailedToSettle"
],
"type": "string",
"description": "This field is mainly used for gateway reconciliation. See <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Gateway_Reconciliation_Consideration\" target=\"_blank\">Electronic payment processing</a> for details.\n\nYou must have the **Edit Payment Gateway Status** <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/User_Roles/e_Payments_Roles\" target=\"_blank\">user permission</a> to update this field.\n"
},
"financeInformation": {
"type": "object",
"properties": {
"transferredToAccounting": {
"enum": [
"Processing",
"Yes",
"No",
"Error",
"Ignore"
],
"type": "string",
"description": "Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
},
"bankAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to a bank account in your accounting system.\n"
},
"unappliedPaymentAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the unapplied payment.\n"
}
},
"description": "Container for the finance information related to the payment.\n\nFor a standalone payment, the finance information cannot be updated.\n"
},
"paymentScheduleKey": {
"type": "string",
"description": "The unique ID or the number of the payment schedule to be linked with the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information."
}
}
},
{
"$ref": "#/components/schemas/PaymentObjectNSFields"
},
{
"$ref": "#/components/schemas/PaymentObjectCustomFields"
}
],
"example": {
"comment": "new comment",
"financeInformation": {
"transferredToAccounting": "No"
}
}
}
UpdateScheduleItems
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID of the invoice schedule item to be updated. \n\nIf this field is not provided, a new invoice schedule item is added to the invoice schedule.\n"
},
"name": {
"type": "string",
"maxLength": 100,
"description": "The name of the invoice schedule item.\n"
},
"amount": {
"type": "string",
"format": "number",
"description": "The amount of the invoice to be generated during the processing of the invoice schedule item. \n\nYou can only specify either the `amount` field or `percentage` field in one request. \n- If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. \n- If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount.\n"
},
"runDate": {
"type": "string",
"format": "date",
"description": "The date in the tenant’s time zone when the invoice schedule item is planned to be processed to generate an invoice.\n"
},
"percentage": {
"description": "The percentage of the total amount to be billed during the processing of the invoice schedule item. \n\nYou can only specify either the `amount` field or `percentage` field in one request. \n- If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. \n- If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount. \n"
},
"targetDateForAdditionalSubscriptions": {
"type": "string",
"format": "date",
"description": "The date in the tenant's time zone used by the invoice schedule to determine which fixed-period regular charges to be billed together with the invoice schedule item. \n\nThe regular charges must come from the subscriptions specified in the `additionalSubscriptionsToBill` field.\n"
}
}
},
{
"$ref": "#/components/schemas/InvoiceScheduleItemCustomFields"
},
{}
],
"title": "scheduleItems"
}
UpdateTask
{
"type": "object",
"title": "task",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the task.\n"
},
"name": {
"type": "string",
"description": "The name of the task.\n"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The array of filter tags.\n"
},
"object": {
"type": "string",
"description": "The selected object for the task.\n"
},
"status": {
"enum": [
"Queued",
"Processing",
"Pending",
"Success",
"Stopped",
"Error"
],
"type": "string",
"description": "The status of the task instance.\n"
},
"call_type": {
"type": "string",
"description": "The type of the API used.\n"
},
"object_id": {
"type": "string",
"description": "The ID of the selected object of the task.\n"
},
"action_type": {
"type": "string",
"description": "The type of task.\n"
},
"workflow_id": {
"type": "integer",
"description": "The ID of the workflow the task belongs to.\n"
},
"concurrent_limit": {
"type": "integer",
"maximum": 9999999,
"minimum": 1,
"description": "The maximum number of this task that can run concurrently.\n"
}
},
"description": "A task.\n"
}
UsageFlatFeePricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"listPrice": {
"type": "number",
"description": "Price of the charge.\n"
},
"originalListPrice": {
"type": "number",
"description": "The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n"
}
}
}
],
"title": "usageFlatFee",
"description": "Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"
}
UsageFlatFeePricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"listPrice": {
"type": "number"
},
"originalListPrice": {
"type": "number",
"description": "The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n"
}
}
}
]
}
UsageObjectCustomFields
{
"type": "object",
"title": "usageFieldsCustom",
"description": "Container for custom fields of a Usage object.\n",
"additionalProperties": {
"description": "Custom fields of the Usage object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n"
}
}
UsageOveragePricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"overagePrice": {
"type": "number",
"description": "Price per overage unit consumed.\n"
},
"includedUnits": {
"type": "number",
"minimum": 0,
"description": "Number of free units that may be consumed.\n"
},
"numberOfPeriods": {
"type": "integer",
"minimum": 1,
"description": "Number of periods that Zuora considers when calculating overage charges with overage smoothing.\n"
},
"unusedUnitsCreditRates": {
"type": "number",
"description": "Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the `overageUnusedUnitsCreditOption` field is `CreditBySpecificRate`.\n"
},
"overageUnusedUnitsCreditOption": {
"enum": [
"NoCredit",
"CreditBySpecificRate"
],
"type": "string",
"description": "Specifies whether to credit the customer for unused units.\n\nIf the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units.\n"
}
}
}
],
"title": "usageOverage",
"description": "Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.\n"
}
UsageOveragePricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"overagePrice": {
"type": "number"
},
"includedUnits": {
"type": "number",
"description": "A certain quantity of units for free in the overage charge model. It cannot be negative. It must be 0 and above. Decimals are allowed.\n"
}
}
}
]
}
UsagePerUnitPricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"uom": {
"type": "number",
"description": "Unit of measure of the standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"listPrice": {
"type": "number",
"description": "Per-unit price of the charge.\n"
},
"ratingGroup": {
"enum": [
"ByBillingPeriod",
"ByUsageStartDate",
"ByUsageRecord",
"ByUsageUpload"
],
"type": "string",
"description": "Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.\n * ByBillingPeriod (default): The rating is based on all the usages in a billing period.\n * ByUsageStartDate: The rating is based on all the usages on the same usage start date. \n * ByUsageRecord: The rating is based on each usage record.\n * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.\n"
},
"originalListPrice": {
"type": "number",
"description": "The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n"
}
}
}
],
"title": "usagePerUnit",
"description": "Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.\n"
}
UsagePerUnitPricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"listPrice": {
"type": "number"
},
"originalListPrice": {
"type": "number",
"description": "The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.\n"
}
}
}
]
}
UsageTieredPricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"uom": {
"type": "string",
"description": "Unit of measure of the standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeTier"
},
"description": "List of cumulative pricing tiers in the charge.\n"
},
"ratingGroup": {
"enum": [
"ByBillingPeriod",
"ByUsageStartDate",
"ByUsageRecord",
"ByUsageUpload"
],
"type": "string",
"description": "Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.\n * ByBillingPeriod (default): The rating is based on all the usages in a billing period.\n * ByUsageStartDate: The rating is based on all the usages on the same usage start date. \n * ByUsageRecord: The rating is based on each usage record.\n * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.\n"
}
}
}
],
"title": "usageTiered",
"description": "Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.\n"
}
UsageTieredPricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeTier"
}
}
}
}
]
}
UsageTieredWithOveragePricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeTier"
},
"description": "List of cumulative pricing tiers in the charge.\n"
},
"overagePrice": {
"type": "number",
"description": "Price per overage unit consumed.\n"
},
"numberOfPeriods": {
"type": "integer",
"minimum": 1,
"description": "Number of periods that Zuora considers when calculating overage charges with overage smoothing.\n"
},
"unusedUnitsCreditRates": {
"type": "number",
"description": "Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the `overageUnusedUnitsCreditOption` field is `CreditBySpecificRate`.\n"
},
"overageUnusedUnitsCreditOption": {
"enum": [
"NoCredit",
"CreditBySpecificRate"
],
"type": "string",
"description": "Specifies whether to credit the customer for unused units.\n\nIf the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units.\n"
}
}
}
],
"title": "usageTieredWithOverage",
"description": "Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.\n"
}
UsageTieredWithOveragePricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeTier"
}
},
"overagePrice": {
"type": "number"
}
}
}
]
}
UsageVolumePricingOverride
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"uom": {
"type": "number",
"description": "Unit of measure of the standalone charge.\n\n**Note:** This field is available when the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Standalone_Orders/AA_Overview_of_Standalone_Orders\" target=\"_blank\">Standalone Orders</a> feature is enabled.\n"
},
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeTier"
},
"description": "List of variable pricing tiers in the charge.\n"
},
"ratingGroup": {
"enum": [
"ByBillingPeriod",
"ByUsageStartDate",
"ByUsageRecord",
"ByUsageUpload"
],
"type": "string",
"description": "Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.\n * ByBillingPeriod (default): The rating is based on all the usages in a billing period.\n * ByUsageStartDate: The rating is based on all the usages on the same usage start date. \n * ByUsageRecord: The rating is based on each usage record.\n * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.\n"
}
}
}
],
"title": "usageVolume",
"description": "Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.\n"
}
UsageVolumePricingUpdate
{
"allOf": [
{
"$ref": "#/components/schemas/PriceChangeParams"
},
{
"type": "object",
"properties": {
"tiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChargeTier"
}
}
}
}
]
}
UsagesResponse
{
"type": "object",
"properties": {
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowUsage"
},
"description": "The list of tasks retrieved.\n"
}
}
}
ValidationErrors
{
"type": "object",
"properties": {
"reasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationReasons"
},
"title": "validation reasons",
"description": "The list of reasons that the request was unsuccessful"
},
"success": {
"type": "boolean",
"description": "Returns `false` if the request was not successful."
}
}
}
ValidationReasons
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "A description why that field is invalid"
},
"fieldName": {
"type": "string",
"description": "The name of the invalid field"
}
}
}
Workflow
{
"type": "object",
"title": "workflow",
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the workflow.\n"
},
"name": {
"type": "string",
"description": "The name of the workflow.\n"
},
"type": {
"enum": [
"Workflow::Setup",
"Workflow::Instance"
],
"type": "string",
"description": "The type of the workflow. Currently the only valid value is 'Workflow::Setup'.\n"
},
"version": {
"type": "string",
"description": "The version number of the workflow. \n"
},
"interval": {
"type": "string",
"description": "The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled.\n"
},
"timezone": {
"type": "string",
"description": "The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled.\n"
},
"createdAt": {
"type": "string",
"format": "datetime",
"description": "The date and time when the workflow is created, in the `YYYY-MM-DD HH:MM:SS` format.\n"
},
"updatedAt": {
"type": "string",
"format": "datetime",
"description": "The date and time when the workflow is updated the last time, in the `YYYY-MM-DD HH:MM:SS` format.\n"
},
"description": {
"type": "string",
"description": "The description of the workflow.\n"
},
"calloutTrigger": {
"type": "boolean",
"description": "Indicates whether the callout trigger is enabled for the retrieved workflow.\n"
},
"ondemandTrigger": {
"type": "boolean",
"description": "Indicates whether the ondemand trigger is enabled for the workflow.\n"
},
"scheduledTrigger": {
"type": "boolean",
"description": "Indicates whether the scheduled trigger is enabled for the workflow.\n"
}
},
"description": "A workflow.\n"
}
WorkflowDefinition
{
"type": "object",
"title": "a workflow definition with version information",
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the workflow definition.\n"
},
"name": {
"type": "string",
"description": "The name of the workflow definition.\n"
},
"status": {
"type": "string",
"description": "The status of the workflow definition.\n"
},
"interval": {
"type": "string",
"description": "The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled.\n"
},
"timezone": {
"type": "string",
"description": "The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled.\n"
},
"createdAt": {
"type": "string",
"format": "datetime",
"description": "The date and time when the workflow is created, in the `YYYY-MM-DD HH:MM:SS` format.\n"
},
"updatedAt": {
"type": "string",
"format": "datetime",
"description": "The date and time when the workflow is updated the last time, in the `YYYY-MM-DD HH:MM:SS` format.\n"
},
"description": {
"type": "string",
"description": "The description of the workflow definition.\n"
},
"active_version": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the active version.\n"
},
"type": {
"enum": [
"Workflow::Setup",
"Workflow::Instance"
],
"type": "string",
"description": "The type of the active version. Currently the only valid value is 'Workflow::Setup'.\n"
},
"status": {
"type": "string",
"description": "The status of the active version.\n"
},
"version": {
"type": "string",
"description": "The version number of the active version.\n"
},
"description": {
"type": "string",
"description": "The description of the active version.\n"
}
},
"description": "Information of the active version. \n"
},
"calloutTrigger": {
"type": "boolean",
"description": "Indicates whether the callout trigger is enabled for the retrieved workflow.\n"
},
"ondemandTrigger": {
"type": "boolean",
"description": "Indicates whether the ondemand trigger is enabled for the workflow.\n"
},
"scheduledTrigger": {
"type": "boolean",
"description": "Indicates whether the scheduled trigger is enabled for the workflow.\n"
}
},
"description": "A workflow.\n"
}
WorkflowDefinitionAndVersions
{
"type": "object",
"title": "a workflow definition with version information",
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the workflow definition.\n"
},
"name": {
"type": "string",
"description": "The name of the workflow definition.\n"
},
"status": {
"type": "string",
"description": "The status of the workflow definition.\n"
},
"interval": {
"type": "string",
"description": "The schedule of the workflow, in a CRON expression. Returns null if the schedued trigger is disabled.\n"
},
"timezone": {
"type": "string",
"description": "The timezone that is configured for the scheduler of the workflow. Returns null if the scheduled trigger is disabled.\n"
},
"createdAt": {
"type": "string",
"format": "datetime",
"description": "The date and time when the workflow is created, in the `YYYY-MM-DD HH:MM:SS` format.\n"
},
"updatedAt": {
"type": "string",
"format": "datetime",
"description": "The date and time when the workflow is updated the last time, in the `YYYY-MM-DD HH:MM:SS` format.\n"
},
"description": {
"type": "string",
"description": "The description of the workflow definition.\n"
},
"active_version": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the active version.\n"
},
"type": {
"enum": [
"Workflow::Setup",
"Workflow::Instance"
],
"type": "string",
"description": "The type of the active version. Currently the only valid value is 'Workflow::Setup'.\n"
},
"status": {
"type": "string",
"description": "The status of the active version.\n"
},
"version": {
"type": "string",
"description": "The version number of the active version.\n"
},
"description": {
"type": "string",
"description": "The description of the active version.\n"
}
},
"description": "Information of the active version. \n"
},
"calloutTrigger": {
"type": "boolean",
"description": "Indicates whether the callout trigger is enabled for the retrieved workflow.\n"
},
"ondemandTrigger": {
"type": "boolean",
"description": "Indicates whether the ondemand trigger is enabled for the workflow.\n"
},
"scheduledTrigger": {
"type": "boolean",
"description": "Indicates whether the scheduled trigger is enabled for the workflow.\n"
},
"latest_inactive_verisons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Workflow"
},
"description": "The list of inactive workflow versions retrieved. Maximum number of versions retrieved is 10. \n"
}
},
"description": "A workflow.\n"
}
WorkflowError
{
"type": "object",
"properties": {
"code": {
"enum": [
"invalid"
],
"type": "string",
"description": "A short error code describing the error"
},
"title": {
"type": "string",
"description": "A human readable description describing the error"
},
"status": {
"type": "integer",
"description": "The http status code for this error"
}
}
}
WorkflowInstance
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the workflow.\n"
},
"name": {
"type": "string",
"description": "The run number of this workflow instance\n"
},
"status": {
"enum": [
"Queued",
"Processing"
],
"type": "string",
"description": "Describes the current state of this workflow instance:\n - Queued: The workflow is in queue for being processed.\n - Processing: The workflow is in process.\n"
},
"createdAt": {
"type": "string",
"format": "datetime",
"description": "The date and time when the workflow is created, in the `YYYY-MM-DD HH:MM:SS` format.\n"
},
"updatedAt": {
"type": "string",
"format": "datetime",
"description": "The date and time the last time when the workflow is updated, in the `YYYY-MM-DD HH:MM:SS` format.\n"
},
"originalWorkflowId": {
"type": "integer",
"description": "The identifier of the workflow template that is used to create this instance.\n"
}
},
"description": "A instance workflow object."
}
WorkflowUsage
{
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date when the usage record is created.\n"
},
"values": {
"type": "object",
"properties": {
"taskCount": {
"type": "integer",
"description": "The amount of task runs that have been used.\n"
}
}
}
},
"description": "The task usage of a particular day.\n"
}
WorkflowsRunWorkflow406Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowError"
},
"description": "The list of errors returned from the workflow"
},
"parameters": {
"description": "The request body that was originally provided to the run API."
}
}
}
WorkflowsRunWorkflow409Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowError"
},
"description": "The list of errors returned from the workflow"
}
}
}
WorkflowsRunWorkflowRequest
{
"type": "object",
"example": {
"accountId": "4028905f5a87c0ff015a87d25ae90025",
"paymentId": "4028905f5a87c0ff015a889ddfb800c0"
},
"properties": {
"accountId": {
"type": "string",
"example": "4028905f5a87c0ff015a87d25ae90025"
},
"paymentId": {
"type": "string",
"example": "4028905f5a87c0ff015a889ddfb800c0"
}
}
}
WorkflowsRunWorkflowResponse
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowError"
},
"description": "The list of errors returned from the workflow"
}
}
}
creditCard
{
"type": "object",
"properties": {
"cardType": {
"enum": [
"Visa",
"MasterCard",
"AmericanExpress",
"Discover",
"JCB",
"Diners",
"CUP",
"Maestro",
"Electron",
"AppleVisa",
"AppleMasterCard",
"AppleAmericanExpress",
"AppleDiscover",
"AppleJCB",
"Elo",
"Hipercard",
"Naranja",
"Nativa",
"TarjetaShopping",
"Cencosud",
"Argencard",
"Cabal"
],
"type": "string",
"description": "Type of card.\n"
},
"cardNumber": {
"type": "string",
"description": "Card number. Once set, you cannot update or query the value of this field. The value of this field is only available in masked format. For example, XXXX-XXXX-XXXX-1234 (hyphens must not be used when you set the credit card number).\n"
},
"securityCode": {
"type": "string",
"description": "CVV or CVV2 security code of the card. To ensure PCI compliance, Zuora does not store the value of this field.\n"
},
"cardHolderInfo": {
"$ref": "#/components/schemas/AccountCreditCardHolder"
},
"expirationYear": {
"type": "integer",
"maximum": 2500,
"minimum": 1980,
"description": "Expiration year of the card.\n"
},
"expirationMonth": {
"type": "integer",
"maximum": 12,
"minimum": 1,
"description": "Expiration date of the card.\n"
}
},
"description": "Default payment method associated with an account. Only credit card payment methods are supported.\n"
}
orderMetric
{
"type": "object",
"properties": {
"elp": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeSlicedElpNetMetrics"
},
"description": "The extended list price which is calculated by the original product catalog list price multiplied by the delta quantity.\n\nThe `elp` nested field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following Order Metrics have been deprecated. Any new customers who onboard on [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/AA_Overview_of_Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nExisting Orders customers who have these metrics will continue to be supported.\n"
},
"mrr": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeSlicedNetMetrics"
}
},
"tcb": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeSlicedTcbNetMetrics"
},
"description": "Total contracted billing which is the forecast value for the total invoice amount."
},
"tcv": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeSlicedNetMetrics"
},
"description": "Total contracted value."
},
"quantity": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeSlicedMetrics"
}
},
"chargeNumber": {
"type": "string"
},
"originRatePlanId": {
"type": "string"
},
"productRatePlanId": {
"type": "string"
},
"productRatePlanChargeId": {
"type": "string"
},
"subscriptionRatePlanNumber": {
"type": "string",
"description": "Number of a subscription rate plan for this subscription.\n"
}
},
"description": "The set of order metrics for an order action."
}
processingOptionsOrders
{
"type": "object",
"properties": {
"refund": {
"type": "boolean",
"description": "Indicates whether to refund after subscription cancelation. Default is `false`. \n\n**Note**: When refunding a subscription that is not invoiced separately, if you do not enable the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement/C_Invoice_Item_Settlement\" target=\"_blank\">Invoice Item Settlement</a> feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”\n"
},
"writeOff": {
"type": "boolean",
"description": "Indicates whether to write off the outstanding balance on the invoice after refund. Default is `false`.\n\n**Note**: \n- When refunding a subscription that is not invoiced separately, if you do not enable the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement/C_Invoice_Item_Settlement\" target=\"_blank\">Invoice Item Settlement</a> feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”\n- The <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement\" target=\"_blank\">Invoice Settlement</a> feature must have been enabled for write-off.\n"
},
"runBilling": {
"type": "boolean",
"description": "Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order.\n"
},
"applyCredit": {
"type": "boolean",
"description": "Whether to automatically apply credit memos or unapplied payments, or both to an invoice.\n\nIf the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices. \n\n\n**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"refundAmount": {
"type": "number",
"description": "Indicates the amount to be refunded. Required if the `refund` field is `true`.\n"
},
"billingOptions": {
"type": "object",
"properties": {
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice is generated. See [What is a Target Date?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/G_Bill_Runs/Creating_Bill_Runs#What_is_a_Target_Date.3F).\n"
},
"documentDate": {
"type": "string",
"format": "date",
"description": "The invoice date displayed on the invoice.\n"
},
"creditMemoReasonCode": {
"type": "string",
"description": "A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code."
},
"generateDraftInvoice": {
"type": "boolean",
"description": "Indicates if the current request needs to generate a draft invoice.\n\nValues are:\n\n* `true`\n* `false` (default)\n"
}
}
},
"collectPayment": {
"type": "boolean",
"description": "Indicates if the current request needs to collect payments. This value can not be 'true' when 'runBilling' flag is 'false'.\n"
},
"applicationOrder": {
"type": "array",
"items": {
"type": "string"
},
"description": "The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.\n\n**Note:**\n - This field is valid only if the `applyCredit` field is set to `true`.\n - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.\n - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.\n"
},
"refundReasonCode": {
"type": "string",
"description": "A code identifying the reason for the refund transaction. The value must be an existing payment refund reason code listed in **Payments Settings** > **Configure Reason Codes**. If you do not specify the field or leave the field with an empty value, Zuora uses the default payment refund reason code.\n"
},
"writeOffBehavior": {
"type": "object",
"properties": {
"financeInformation": {
"type": "object",
"properties": {
"onAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n"
}
},
"description": "Container for the finance information related to the credit memo items that are created for invoice write-off.\n"
}
},
"description": "The financial information of the credit memo items generated to write off the invoice balance. \n\n**Note:** \n - All the credit memo items that are used to write off the invoice will be applied with the same financial information.\n - Credit memo items generated from the unconsumed services of the canceled subscription will not be applied with the finance information specified here.\n"
},
"applyCreditBalance": {
"type": "boolean",
"description": "Indicates if any credit balance on a customer's account is automatically applied to invoices. If no value is specified then this field defaults to false. This feature is not available if you have enabled the Invoice Settlement feature.\n"
},
"electronicPaymentOptions": {
"type": "object",
"properties": {
"paymentMethodId": {
"type": "string",
"description": "Specifies an electronic payment method. It can be one that has already been associated with an invoice owner, or an orphan payment method, which is not associated with any invoice owner. For an orphan payment method, this operation will then associate it with the account that this order will be created under.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "Specifies the ID of a payment gateway to override the default gateway. If this field is not specified, the default payment gateway will be used to process the payment.\n"
}
},
"description": "Container for the electronic payment options.\n"
}
},
"description": "The container for billing processing options and payment processing options.\n\n**Note:**\n- This field is not supported in draft orders.\n- When you use the \"Create an order\" operation to create an account, create a subscription, run billing, and collect payment in a single call, if any error occurs during the call, such as a payment processing failure and a tax engine failure, then all the other steps will be rolled back. In this case, neither the invoice will be generated, nor the subscription nor the account will be created.\n- When you use the \"Create an order\" operation to cancel a subscription with `refund` and `writeOff`, if the `refund` or `writeOff` fails, `cancelSubscription`, `runBilling`, and `collectPayment` still can succeed.\n- When you use the \"Create an order\" operation, the `collectPayment` and `refund` fields cannot be set to `true` simultaneously. Otherwise, the order will not be proceeded.\n"
}
processingOptionsOrdersAsync
{
"type": "object",
"properties": {
"runBilling": {
"type": "boolean",
"description": "Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order.\n"
},
"applyCredit": {
"type": "boolean",
"description": "\n- If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices\n\n\n**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"billingOptions": {
"type": "object",
"properties": {
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice is generated. See [What is a Target Date?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/G_Bill_Runs/Creating_Bill_Runs#What_is_a_Target_Date.3F).\n"
},
"documentDate": {
"type": "string",
"format": "date",
"description": "The invoice date displayed on the invoice.\n"
},
"creditMemoReasonCode": {
"type": "string",
"description": "A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code."
},
"generateDraftInvoice": {
"type": "boolean",
"description": "Indicates if the current request needs to generate a draft invoice.\n\nValues are:\n\n* `true`\n* `false` (default)\n"
}
}
},
"collectPayment": {
"type": "boolean",
"description": "Indicates if the current request needs to collect payments. This value can not be 'true' when 'runBilling' flag is 'false'.\n"
},
"applicationOrder": {
"type": "array",
"items": {
"type": "string"
},
"description": "The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.\n\n**Note:**\n - This field is valid only if the `applyCredit` field is set to `true`.\n - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.\n - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.\n"
},
"applyCreditBalance": {
"type": "boolean",
"description": "Indicates if any credit balance on a customer's account is automatically applied to invoices. If no value is specified then this field defaults to false. This feature is not available if you have enabled the Invoice Settlement feature.\n"
},
"electronicPaymentOptions": {
"type": "object",
"properties": {
"paymentMethodId": {
"type": "string",
"description": "Specifies an electronic payment method. It can be one that has already been associated with an invoice owner, or an orphan payment method, which is not associated with any invoice owner. For an orphan payment method, this operation will then associate it with the account that this order will be created under.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "Specifies the ID of a payment gateway to override the default gateway. If this field is not specified, the default payment gateway will be used to process the payment.\n"
}
},
"description": "Container for the electronic payment options.\n"
}
},
"description": "The container for billing processing options and payment processing options.\n\n**Note:** This field is not supported in draft orders.\n"
}
processingOptionsOrdersWithDelayedCapturePayment
{
"type": "object",
"properties": {
"refund": {
"type": "boolean",
"description": "Indicates whether to refund after subscription cancelation. Default is `false`. \n\n**Note**: When refunding a subscription that is not invoiced separately, if you do not enable the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement/C_Invoice_Item_Settlement\" target=\"_blank\">Invoice Item Settlement</a> feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”\n"
},
"writeOff": {
"type": "boolean",
"description": "Indicates whether to write off the outstanding balance on the invoice after refund. Default is `false`.\n\n**Note**: \n- When refunding a subscription that is not invoiced separately, if you do not enable the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement/C_Invoice_Item_Settlement\" target=\"_blank\">Invoice Item Settlement</a> feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”\n- The <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement\" target=\"_blank\">Invoice Settlement</a> feature must have been enabled for write-off.\n"
},
"runBilling": {
"type": "boolean",
"description": "Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order.\n"
},
"applyCredit": {
"type": "boolean",
"description": "Whether to automatically apply credit memos or unapplied payments, or both to an invoice.\n\nIf the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices. \n\n\n**Note:** This field 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/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n"
},
"refundAmount": {
"type": "number",
"description": "Indicates the amount to be refunded. Required if the `refund` field is `true`.\n"
},
"billingOptions": {
"type": "object",
"properties": {
"targetDate": {
"type": "string",
"format": "date",
"description": "Date through which to calculate charges if an invoice is generated. See [What is a Target Date?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/G_Bill_Runs/Creating_Bill_Runs#What_is_a_Target_Date.3F).\n"
},
"documentDate": {
"type": "string",
"format": "date",
"description": "The invoice date displayed on the invoice.\n"
},
"creditMemoReasonCode": {
"type": "string",
"description": "A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code."
},
"generateDraftInvoice": {
"type": "boolean",
"description": "Indicates if the current request needs to generate a draft invoice.\n\nValues are:\n\n* `true`\n* `false` (default)\n"
}
}
},
"collectPayment": {
"type": "boolean",
"description": "Indicates if the current request needs to collect payments. This value can not be 'true' when 'runBilling' flag is 'false'.\n"
},
"applicationOrder": {
"type": "array",
"items": {
"type": "string"
},
"description": "The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`.\n\n**Note:**\n - This field is valid only if the `applyCredit` field is set to `true`.\n - If no value is specified for this field, the default priority order is used, [\"CreditMemo\", \"UnappliedPayment\"], to apply credit memos first and then apply unapplied payments.\n - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `[\"CreditMemo\"]`, only credit memos are used to apply to invoices.\n"
},
"refundReasonCode": {
"type": "string",
"description": "A code identifying the reason for the refund transaction. The value must be an existing payment refund reason code listed in **Payments Settings** > **Configure Reason Codes**. If you do not specify the field or leave the field with an empty value, Zuora uses the default payment refund reason code.\n"
},
"writeOffBehavior": {
"type": "object",
"properties": {
"financeInformation": {
"type": "object",
"properties": {
"onAccountAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code that maps to an on account in your accounting system.\n"
},
"revenueRecognitionRuleName": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The name of the revenue recognition rule governing the revenue schedule.\n"
},
"deferredRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n"
},
"recognizedRevenueAccountingCode": {
"type": "string",
"maxLength": 100,
"minLength": 0,
"description": "The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n"
}
},
"description": "Container for the finance information related to the credit memo items that are created for invoice write-off.\n"
}
},
"description": "The financial information of the credit memo items generated to write off the invoice balance. \n\n**Note:** \n - All the credit memo items that are used to write off the invoice will be applied with the same financial information.\n - Credit memo items generated from the unconsumed services of the canceled subscription will not be applied with the finance information specified here.\n"
},
"applyCreditBalance": {
"type": "boolean",
"description": "Indicates if any credit balance on a customer's account is automatically applied to invoices. If no value is specified then this field defaults to false. This feature is not available if you have enabled the Invoice Settlement feature.\n"
},
"electronicPaymentOptions": {
"type": "object",
"properties": {
"gatewayOrderId": {
"type": "string",
"maxLength": 50,
"description": "A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead.\n\nGateways check duplicates on the gateway order ID to ensure that the same transaction is not entered twice accidentally. \n\nThis ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems.\n\nWhen you create a payment to capture the funds that have been authorized through [Create authorization](https://developer.zuora.com/api-references/api/operation/POST_CreateAuthorization/), pass in the `authTransactionId` field. It is highly recommended to also pass in `gatewayOrderId` that you used when authorizing the funds. `authTransactionId` is required, while `gatewayOrderId` is optional.\n"
},
"paymentMethodId": {
"type": "string",
"description": "Specifies an electronic payment method. It can be one that has already been associated with an invoice owner, or an orphan payment method, which is not associated with any invoice owner. For an orphan payment method, this operation will then associate it with the account that this order will be created under.\n"
},
"paymentGatewayId": {
"type": "string",
"description": "Specifies the ID of a payment gateway to override the default gateway.\n\nIf <a href=\"https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Payment_Gateway_Routing\" target=\"_blank\">Payment Gateway Routing</a> is enabled: \n - If this field is not specified, gateway routing rules will be invoked.\n - If this field is specified, the specified gateway will be used to process the payment.\n\nIf Payment Gateway Routing is disabled:\n - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant.\n - If this field is specified, the specified gateway will be used to process the payment.\n"
},
"authTransactionId": {
"type": "string",
"maxLength": 50,
"description": "The authorization transaction ID from the payment gateway.\n\nWhen you create a payment to capture the funds that have been authorized through [Create authorization](https://developer.zuora.com/api-references/api/operation/POST_CreateAuthorization/), pass in the `authTransactionId` field. It is highly recommended to also pass in `gatewayOrderId` that you used when authorizing the funds. `authTransactionId` is required, while `gatewayOrderId` is optional.\n"
}
},
"description": "Container for the electronic payment options.\n"
}
},
"description": "The container for billing processing options and payment processing options.\n\n**Note:**\n- This field is not supported in draft orders.\n- When you use the \"Create an order\" operation to create an account, create a subscription, run billing, and collect payment in a single call, if any error occurs during the call, such as a payment processing failure and a tax engine failure, then all the other steps will be rolled back. In this case, neither the invoice will be generated, nor the subscription nor the account will be created.\n- When you use the \"Create an order\" operation to cancel a subscription with `refund` and `writeOff`, if the `refund` or `writeOff` fails, `cancelSubscription`, `runBilling`, and `collectPayment` still can succeed.\n- When you use the \"Create an order\" operation, the `collectPayment` and `refund` fields cannot be set to `true` simultaneously. Otherwise, the order will not be proceeded.\n"
}
tokenResponse
{
"type": "object",
"properties": {
"jti": {
"type": "string",
"description": "A globally unique identifier for the token."
},
"scope": {
"type": "string",
"description": "A space-delimited list of scopes that the token can be used to access."
},
"expires_in": {
"type": "number",
"description": "The number of seconds until the token expires."
},
"token_type": {
"type": "string",
"description": "The type of token that was generated, i.e., `bearer`."
},
"access_token": {
"type": "string",
"description": "The generated token."
}
}
}
zObject
{
"type": "object",
"additionalProperties": {
"description": "Field of the object.\n"
}
}
zObject_update
{
"allOf": [
{
"type": "object",
"required": [
"Id"
],
"properties": {
"Id": {
"type": "string",
"description": ""
},
"fieldsToNull": {
"type": "array",
"items": {
"type": "string"
},
"description": "Used to set a list of fields to null.\n"
}
}
},
{
"$ref": "#/components/schemas/zObject"
}
],
"title": "zObject"
}