Resubmit the request first to have another try.
If this error still occurs, contact Zuora Global Support with the returned `Zuora-Request-Id` value in the response header for assistance.
|\n| 60 | Internal error | The server encounters an internal error. | Contact Zuora Global Support with the returned `Zuora-Request-Id` value in the response header for assistance. |\n| 61 | Temporary error | A temporary error occurs during request processing, for example, a database communication error. |Resubmit the request first to have another try.
If this error still occurs, contact Zuora Global Support with the returned `Zuora-Request-Id` value in the response header for assistance.
|\n| 70 | Request exceeded limit | The total number of concurrent requests exceeds the limit allowed by the system. |Resubmit the request after the number of seconds specified by the `Retry-After` value in the response header.
Check [Concurrent request limits](/rest-api/general-concepts/rate-concurrency-limits/) for details about Zuora’s concurrent request limit policy.
|\n| 90 | Malformed request | The request cannot be processed due to JSON syntax errors. | Check the syntax error in the JSON request body and ensure that the request is in the correct JSON format. |\n| 99 | Integration error | The server encounters an error when communicating with an external system, for example, payment gateway, tax engine provider. | Check the response message and take action accordingly. |\n\n\n# API Versions\n\nThe Zuora REST API are version controlled. Versioning ensures that Zuora REST API changes are backward compatible. Zuora uses a major and minor version nomenclature to manage changes. By specifying a version in a REST request, you can get expected responses regardless of future changes to the API.\n\n## Major Version\n\nThe major version number of the REST API appears in the REST URL. In this API reference, only the **v1** major version is available. For example, `POST https://rest.zuora.com/v1/subscriptions`.\n\n## Minor Version\n\nZuora uses minor versions for the REST API to control small changes. For example, a field in a REST method is deprecated and a new field is used to replace it. \n\nSome fields in the REST methods are supported as of minor versions. If a field is not noted with a minor version, this field is available for all minor versions. If a field is noted with a minor version, this field is in version control. You must specify the supported minor version in the request header to process without an error. \n\nIf a field is in version control, it is either with a minimum minor version or a maximum minor version, or both of them. You can only use this field with the minor version between the minimum and the maximum minor versions. For example, the `invoiceCollect` field in the POST Subscription method is in version control and its maximum minor version is 189.0. You can only use this field with the minor version 189.0 or earlier.\n\nIf you specify a version number in the request header that is not supported, Zuora will use the minimum minor version of the REST API. In our REST API documentation, if a field or feature requires a minor version number, we note that in the field description.\n\nYou only need to specify the version number when you use the fields require a minor version. To specify the minor version, set the `zuora-version` parameter to the minor version number in the request header for the request call. For example, the `collect` field is in 196.0 minor version. If you want to use this field for the POST Subscription method, set the `zuora-version` parameter to `196.0` in the request header. The `zuora-version` parameter is case sensitive.\n\nFor all the REST API fields, by default, if the minor version is not specified in the request header, Zuora will use the minimum minor version of the REST API to avoid breaking your integration. \n\n### Minor Version History\n\nThe supported minor versions are not consecutive. \nYou can use the following versions to override the default version (`186.0`):\n - 187.0\n - 188.0\n - 189.0\n - 196.0\n - 206.0\n - 207.0\n - 211.0\n - 214.0\n - 215.0\n - 216.0\n - 223.0\n - 224.0\n - 230.0\n - 239.0\n - 256.0\n - 257.0\n - 309.0\n - 314.0\n - 315.0\n - 329.0\n - 330.0\n - 336.0\n - 337.0\n - 338.0\n - 341.0\n\nIf you set the `zuora-version` header to a version excluded from the preceding list, the corresponding API request is processed as you use the default version, `186.0`.\n\nThe following table lists the supported versions and the fields that have a Zuora REST API minor version.\n\n| Fields | Minor Version | REST Methods | Description |\n|:--------|:--------|:--------|:--------|\n| invoiceCollect | 189.0 and earlier | [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Generates an invoice and collects a payment for a subscription. |\n| collect | 196.0 and later | [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Collects an automatic payment for a subscription. |\n| invoice | 196.0 and 207.0| [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Generates an invoice for a subscription. |\n| invoiceTargetDate | 206.0 and earlier | [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\") |Date through which charges are calculated on the invoice, as `yyyy-mm-dd`. |\n| invoiceTargetDate | 207.0 and earlier | [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Date through which charges are calculated on the invoice, as `yyyy-mm-dd`. |\n| targetDate | 207.0 and later | [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\") |Date through which charges are calculated on the invoice, as `yyyy-mm-dd`. |\n| targetDate | 211.0 and later | [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Date through which charges are calculated on the invoice, as `yyyy-mm-dd`. |\n| includeExisting DraftInvoiceItems | 206.0 and earlier| [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\") | Specifies whether to include draft invoice items in subscription previews. Specify it to be `true` (default) to include draft invoice items in the preview result. Specify it to be `false` to excludes draft invoice items in the preview result. |\n| includeExisting DraftDocItems | 207.0 and later | [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\") | Specifies whether to include draft invoice items in subscription previews. Specify it to be `true` (default) to include draft invoice items in the preview result. Specify it to be `false` to excludes draft invoice items in the preview result. |\n| previewType | 206.0 and earlier| [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\") | The type of preview you will receive. The possible values are `InvoiceItem`(default), `ChargeMetrics`, and `InvoiceItemChargeMetrics`. |\n| previewType | 207.0 and later | [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\") | The type of preview you will receive. The possible values are `LegalDoc`(default), `ChargeMetrics`, and `LegalDocChargeMetrics`. |\n| runBilling | 211.0 and later | [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Generates an invoice or credit memo for a subscription. **Note:** Credit memos are only available if you have the Invoice Settlement feature enabled. |\n| invoiceDate | 214.0 and earlier | [Invoice and Collect](/api-references/api/operation/POST_TransactionInvoicePayment \"Invoice and Collect\") |Date that should appear on the invoice being generated, as `yyyy-mm-dd`. |\n| invoiceTargetDate | 214.0 and earlier | [Invoice and Collect](/api-references/api/operation/POST_TransactionInvoicePayment \"Invoice and Collect\") |Date through which to calculate charges on this account if an invoice is generated, as `yyyy-mm-dd`. |\n| documentDate | 215.0 and later | [Invoice and Collect](/api-references/api/operation/POST_TransactionInvoicePayment \"Invoice and Collect\") |Date that should appear on the invoice and credit memo being generated, as `yyyy-mm-dd`. |\n| targetDate | 215.0 and later | [Invoice and Collect](/api-references/api/operation/POST_TransactionInvoicePayment \"Invoice and Collect\") |Date through which to calculate charges on this account if an invoice or a credit memo is generated, as `yyyy-mm-dd`. |\n| memoItemAmount | 223.0 and earlier | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\") | Amount of the memo item. |\n| amount | 224.0 and later | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\") | Amount of the memo item. |\n| subscriptionNumbers | 222.4 and earlier | [Create order](/api-references/api/operation/POST_Order \"Create order\") | Container for the subscription numbers of the subscriptions in an order. |\n| subscriptions | 223.0 and later | [Create order](/api-references/api/operation/POST_Order \"Create order\") | Container for the subscription numbers and statuses in an order. |\n| creditTaxItems | 238.0 and earlier | [Get credit memo items](/api-references/api/operation/GET_CreditMemoItems \"Get credit memo items\"); [Get credit memo item](/api-references/api/operation/GET_CreditMemoItem \"Get credit memo item\") | Container for the taxation items of the credit memo item. |\n| taxItems | 238.0 and earlier | [Get debit memo items](/api-references/api/operation/GET_DebitMemoItems \"Get debit memo items\"); [Get debit memo item](/api-references/api/operation/GET_DebitMemoItem \"Get debit memo item\") | Container for the taxation items of the debit memo item. |\n| taxationItems | 239.0 and later | [Get credit memo items](/api-references/api/operation/GET_CreditMemoItems \"Get credit memo items\"); [Get credit memo item](/api-references/api/operation/GET_CreditMemoItem \"Get credit memo item\"); [Get debit memo items](/api-references/api/operation/GET_DebitMemoItems \"Get debit memo items\"); [Get debit memo item](/api-references/api/operation/GET_DebitMemoItem \"Get debit memo item\") | Container for the taxation items of the memo item. |\n| chargeId | 256.0 and earlier | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\") | ID of the product rate plan charge that the memo is created from. |\n| productRatePlanChargeId | 257.0 and later | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\") | ID of the product rate plan charge that the memo is created from. |\n| comment | 256.0 and earlier | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\"); [Create credit memo from invoice](/api-references/api/operation/POST_CreditMemoFromInvoice \"Create credit memo from invoice\"); [Create debit memo from invoice](/api-references/api/operation/POST_DebitMemoFromInvoice \"Create debit memo from invoice\"); [Get credit memo items](/api-references/api/operation/GET_CreditMemoItems \"Get credit memo items\"); [Get credit memo item](/api-references/api/operation/GET_CreditMemoItem \"Get credit memo item\"); [Get debit memo items](/api-references/api/operation/GET_DebitMemoItems \"Get debit memo items\"); [Get debit memo item](/api-references/api/operation/GET_DebitMemoItem \"Get debit memo item\") | Comments about the product rate plan charge, invoice item, or memo item. |\n| description | 257.0 and later | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\"); [Create credit memo from invoice](/api-references/api/operation/POST_CreditMemoFromInvoice \"Create credit memo from invoice\"); [Create debit memo from invoice](/api-references/api/operation/POST_DebitMemoFromInvoice \"Create debit memo from invoice\"); [Get credit memo items](/api-references/api/operation/GET_CreditMemoItems \"Get credit memo items\"); [Get credit memo item](/api-references/api/operation/GET_CreditMemoItem \"Get credit memo item\"); [Get debit memo items](/api-references/api/operation/GET_DebitMemoItems \"Get debit memo items\"); [Get debit memo item](/api-references/api/operation/GET_DebitMemoItem \"Get debit memo item\") | Description of the the product rate plan charge, invoice item, or memo item. |\n| taxationItems | 309.0 and later | [Preview an order](/api-references/api/operation/POST_PreviewOrder \"Preview an order\") | List of taxation items for an invoice item or a credit memo item. |\n| batch | 309.0 and earlier | [Create a billing preview run](/api-references/api/operation/POST_BillingPreviewRun \"Create a billing preview run\") | The customer batches to include in the billing preview run. | \n| batches | 314.0 and later | [Create a billing preview run](/api-references/api/operation/POST_BillingPreviewRun \"Create a billing preview run\") | The customer batches to include in the billing preview run. |\n| taxationItems | 315.0 and later | [Preview a subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview a subscription\"); [Update a subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update a subscription\")| List of taxation items for an invoice item or a credit memo item. |\n| billingDocument | 330.0 and later | [Create a payment schedule](/api-references/api/operation/POST_PaymentSchedule \"Create a payment schedule\"); [Create multiple payment schedules at once](/api-references/api/operation/POST_PaymentSchedules \"Create multiple payment schedules at once\")| The billing document with which the payment schedule item is associated. |\n| paymentId | 336.0 and earlier | [Add payment schedule items to a custom payment schedule](/api-references/api/operation/POST_AddItemsToCustomPaymentSchedule/ \"Add payment schedule items to a custom payment schedule\"); [Update a payment schedule](/api-references/api/operation/PUT_PaymentSchedule/ \"Update a payment schedule\"); [Update a payment schedule item](/api-references/api/operation/PUT_PaymentScheduleItem/ \"Update a payment schedule item\"); [Preview the result of payment schedule update](/api-references/api/operation/PUT_PaymentScheduleUpdatePreview/ \"Preview the result of payment schedule update\"); [Retrieve a payment schedule](/api-references/api/operation/GET_PaymentSchedule/ \"Retrieve a payment schedule\"); [Retrieve a payment schedule item](/api-references/api/operation/GET_PaymentScheduleItem/ \"Retrieve a payment schedule item\"); [List payment schedules by customer account](/api-references/api/operation/GET_PaymentSchedules/ \"List payment schedules by customer account\"); [Cancel a payment schedule](/api-references/api/operation/PUT_CancelPaymentSchedule/ \"Cancel a payment schedule\"); [Cancel a payment schedule item](/api-references/api/operation/PUT_CancelPaymentScheduleItem/ \"Cancel a payment schedule item\");[Skip a payment schedule item](/api-references/api/operation/PUT_SkipPaymentScheduleItem/ \"Skip a payment schedule item\");[Retry failed payment schedule items](/api-references/api/operation/POST_RetryPaymentScheduleItem/ \"Retry failed payment schedule items\") | ID of the payment to be linked to the payment schedule item.\n\n\n#### Version 207.0 and Later\n\nThe response structure of the [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription) and [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\") methods are changed. The following invoice related response fields are moved to the invoice container:\n\n * amount\n * amountWithoutTax\n * taxAmount\n * invoiceItems\n * targetDate\n * chargeMetrics\n\n\n# API Names for Zuora Objects\n\nFor information about the Zuora business object model, see [Zuora Business Object Model](/rest-api/general-concepts/object-model/).\n\nYou can use the [Describe](/api-references/api/operation/GET_Describe) operation to list the fields of each Zuora object that is available in your tenant. When you call the operation, you must specify the API name of the Zuora object.\n\nThe following table provides the API name of each Zuora object:\n\n| Object | API Name |\n|-----------------------------------------------|--------------------------------------------|\n| Account | `Account` |\n| Accounting Code | `AccountingCode` |\n| Accounting Period | `AccountingPeriod` |\n| Amendment | `Amendment` |\n| Application Group | `ApplicationGroup` |\n| Billing Run |`BillingRun` - API name used in the [Describe](/api-references/api/operation/GET_Describe) operation, Export ZOQL queries, and Data Query.
`BillRun` - API name used in the [Actions](/v1-api-reference/api/Actions). See the CRUD oprations of [Bill Run](/v1-api-reference/api/Bill-Run) for more information about the `BillRun` object. `BillingRun` and `BillRun` have different fields. | \n| Billing Preview Run | `BillingPreviewRun` | \n| Configuration Templates | `ConfigurationTemplates` |\n| Contact | `Contact` |\n| Contact Snapshot | `ContactSnapshot` |\n| Credit Balance Adjustment | `CreditBalanceAdjustment` |\n| Credit Memo | `CreditMemo` |\n| Credit Memo Application | `CreditMemoApplication` |\n| Credit Memo Application Item | `CreditMemoApplicationItem` |\n| Credit Memo Item | `CreditMemoItem` |\n| Credit Memo Part | `CreditMemoPart` |\n| Credit Memo Part Item | `CreditMemoPartItem` |\n| Credit Taxation Item | `CreditTaxationItem` |\n| Custom Exchange Rate | `FXCustomRate` |\n| Debit Memo | `DebitMemo` |\n| Debit Memo Item | `DebitMemoItem` |\n| Debit Taxation Item | `DebitTaxationItem` |\n| Discount Applied Metrics | `DiscountAppliedMetrics` |\n| Entity | `Tenant` |\n| Fulfillment | `Fulfillment` |\n| Feature | `Feature` |\n| Gateway Reconciliation Event | `PaymentGatewayReconciliationEventLog` |\n| Gateway Reconciliation Job | `PaymentReconciliationJob` |\n| Gateway Reconciliation Log | `PaymentReconciliationLog` |\n| Invoice | `Invoice` |\n| Invoice Adjustment | `InvoiceAdjustment` |\n| Invoice Item | `InvoiceItem` |\n| Invoice Item Adjustment | `InvoiceItemAdjustment` |\n| Invoice Payment | `InvoicePayment` |\n| Invoice Schedule | `InvoiceSchedule` |\n| Invoice Schedule Item | `InvoiceScheduleItem` |\n| Journal Entry | `JournalEntry` |\n| Journal Entry Item | `JournalEntryItem` |\n| Journal Run | `JournalRun` |\n| Notification History - Callout | `CalloutHistory` |\n| Notification History - Email | `EmailHistory` |\n| Offer | `Offer` |\n| Order | `Order` |\n| Order Action | `OrderAction` |\n| Order ELP | `OrderElp` |\n| Order Line Items | `OrderLineItems` | \n| Order Item | `OrderItem` |\n| Order MRR | `OrderMrr` |\n| Order Quantity | `OrderQuantity` |\n| Order TCB | `OrderTcb` |\n| Order TCV | `OrderTcv` |\n| Payment | `Payment` |\n| Payment Application | `PaymentApplication` |\n| Payment Application Item | `PaymentApplicationItem` |\n| Payment Method | `PaymentMethod` |\n| Payment Method Snapshot | `PaymentMethodSnapshot` |\n| Payment Method Transaction Log | `PaymentMethodTransactionLog` |\n| Payment Method Update | `UpdaterDetail` |\n| Payment Part | `PaymentPart` |\n| Payment Part Item | `PaymentPartItem` |\n| Payment Run | `PaymentRun` |\n| Payment Transaction Log | `PaymentTransactionLog` |\n| Price Book Item | `PriceBookItem` |\n| Processed Usage | `ProcessedUsage` |\n| Product | `Product` |\n| Product Charge Definition | `ProductChargeDefinition` | \n| Product Feature | `ProductFeature` |\n| Product Rate Plan | `ProductRatePlan` |\n| Product Rate Plan Definition | `ProductRatePlanDefinition` | \n| Product Rate Plan Charge | `ProductRatePlanCharge` |\n| Product Rate Plan Charge Tier | `ProductRatePlanChargeTier` |\n| Rate Plan | `RatePlan` |\n| Rate Plan Charge | `RatePlanCharge` |\n| Rate Plan Charge Tier | `RatePlanChargeTier` |\n| Refund | `Refund` |\n| Refund Application | `RefundApplication` |\n| Refund Application Item | `RefundApplicationItem` |\n| Refund Invoice Payment | `RefundInvoicePayment` |\n| Refund Part | `RefundPart` |\n| Refund Part Item | `RefundPartItem` |\n| Refund Transaction Log | `RefundTransactionLog` |\n| Revenue Charge Summary | `RevenueChargeSummary` |\n| Revenue Charge Summary Item | `RevenueChargeSummaryItem` |\n| Revenue Event | `RevenueEvent` |\n| Revenue Event Credit Memo Item | `RevenueEventCreditMemoItem` |\n| Revenue Event Debit Memo Item | `RevenueEventDebitMemoItem` |\n| Revenue Event Invoice Item | `RevenueEventInvoiceItem` |\n| Revenue Event Invoice Item Adjustment | `RevenueEventInvoiceItemAdjustment` |\n| Revenue Event Item | `RevenueEventItem` |\n| Revenue Event Item Credit Memo Item | `RevenueEventItemCreditMemoItem` |\n| Revenue Event Item Debit Memo Item | `RevenueEventItemDebitMemoItem` |\n| Revenue Event Item Invoice Item | `RevenueEventItemInvoiceItem` |\n| Revenue Event Item Invoice Item Adjustment | `RevenueEventItemInvoiceItemAdjustment` |\n| Revenue Event Type | `RevenueEventType` |\n| Revenue Schedule | `RevenueSchedule` |\n| Revenue Schedule Credit Memo Item | `RevenueScheduleCreditMemoItem` |\n| Revenue Schedule Debit Memo Item | `RevenueScheduleDebitMemoItem` |\n| Revenue Schedule Invoice Item | `RevenueScheduleInvoiceItem` |\n| Revenue Schedule Invoice Item Adjustment | `RevenueScheduleInvoiceItemAdjustment` |\n| Revenue Schedule Item | `RevenueScheduleItem` |\n| Revenue Schedule Item Credit Memo Item | `RevenueScheduleItemCreditMemoItem` |\n| Revenue Schedule Item Debit Memo Item | `RevenueScheduleItemDebitMemoItem` |\n| Revenue Schedule Item Invoice Item | `RevenueScheduleItemInvoiceItem` |\n| Revenue Schedule Item Invoice Item Adjustment | `RevenueScheduleItemInvoiceItemAdjustment` |\n| Subscription | `Subscription` |\n| Subscription Product Feature | `SubscriptionProductFeature` |\n| Taxable Item Snapshot | `TaxableItemSnapshot` |\n| Taxation Item | `TaxationItem` |\n| Updater Batch | `UpdaterBatch` |\n| Usage | `Usage` |\n"
contact:
email: docs@zuora.com
host: rest.zuora.com
basePath: /
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: Accounts
description: 'Some operations in this section are similar to each other, but are provided for different use scenarios. You should choose the one that best suits your needs.
For example, the [Create account](/v1-api-reference/api/accounts/post_account) operation is used to create an account with a credit card payment method, a bill-to contact, and optionally an sold-to contact or an associated subscription. If you want to create an account without creating any associated objects such as subscriptions, use [CRUD: Create Account](/api-references/api/operation/Object_POSTAccount) instead.
If you want to create an account and the associated subscription at the same time without providing credit card information, use the [Subscribe](/api-references/api/operation/Action_POSTsubscribe) action.
'
paths:
/v1/accounts:
post:
summary: Create an account
operationId: POST_Account
description: "Creates a customer account with a payment method, a bill-to contact, and an optional sold-to contact. Request and response field descriptions and sample code are provided. Use this operation to optionally create a subscription, invoice for that subscription, and collect payment through the default payment method. The transaction is atomic; if any part fails for any reason, the entire transaction is rolled back.\n\nThis operation is CORS Enabled, so you can use client-side Javascript to invoke the call. \n\n### Notes\n1. The account is created in active status. \n2. If the `autoPay` field is set to `true` in the request, you must provide one of the `paymentMethod`, `creditCard`, or `hpmCreditCardPaymentMethodId` field, but not multiple. The one provided becomes the default payment method for this account. If the credit card information is declined or cannot be verified, no account is created.\n3. Customer accounts created with this call are automatically be set to Auto Pay.\n4. If the `invoiceDeliveryPrefsEmail` field is not specified in the request, the account's email delivery preference is always automatically set to `false`, no matter whether the `workEmail` or `personalEmail` field is specified.\n\n### Defaults for customerAcceptanceDate and serviceActivationDate\nDefault values for **customerAcceptanceDate** and **serviceActivationDate** are set as follows.\n\n| | serviceActivationDate(SA) specified | serviceActivationDate (SA) NOT specified |\n| ------------- |:-------------:| -----:|\n| customerAcceptanceDate (CA) specified | SA uses value in the request call; CA uses value in the request call| CA uses value in the request call;SA uses CE as default |\n| customerAcceptanceDate (CA) NOT specified | SA uses value in the request call; CA uses SA as default | SA and CA use CE as default |\n"
tags:
- Accounts
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: zuora-version
in: header
required: false
type: string
description: "The minor version of the Zuora REST API. \n\nYou only need to set this parameter if you use the following fields:\n* invoice\n* collect\n* runBilling\n* targetDate\n"
- name: Request
in: body
description: ''
required: true
schema:
$ref: '#/definitions/POSTAccountType'
responses:
'200':
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
examples:
application/json:
success: true
accountId: 402892c74c9193cd014c96bbe7c101f9
accountNumber: A00000004
billToContactId: 2c92c8fb68a28d180168a7ccedba1c4c
soldToContactId: 2c92c8fb68a28d180168a7ccedc61c4e
paymentMethodId: 402892c74c9193cd014c96bbe7d901fd
description: ''
schema:
$ref: '#/definitions/POSTAccountResponseType'
/v1/accounts/{account-key}:
get:
summary: Retrieve an account
operationId: GET_Account
description: 'Retrieves basic information about a customer account.
This operation is a quick retrieval that doesn''t include the account''s subscriptions, invoices, payments, or usage details. Use Get account summary to get more detailed information about an account.
'
tags:
- Accounts
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: account-key
in: path
description: Account number or account ID.
required: true
type: string
responses:
'200':
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
examples:
application/json:
basicInfo:
id: 402892c74c9193cd014c91d35b0a0132
name: Test
accountNumber: A00000001
notes: ''
status: Active
crmId: ''
batch: Batch1
invoiceTemplateId: null
communicationProfileId: 303d186840e611df817c002185d714e1
profileNumber: CP-00000012
salesRep: ''
sequenceSetId: null
partnerAccount: false
billingAndPayment:
autoPay: true
billCycleDay: 1
currency: USD
defaultPaymentMethodId: 2c93808457d787030157e03220ec4fad
paymentTerm: Net 30
paymentGateway: TestGateway
invoiceDeliveryPrefsPrint: false
invoiceDeliveryPrefsEmail: true
additionalEmailAddresses:
- contact1@example.com
- contact2@example.com
metrics:
balance: 0
totalInvoiceBalance: 0
creditBalance: 0
contractedMrr: -900
metricsData:
- currency: USD
balance: 0
totalInvoiceBalance: 0
totalDebitMemoBalance: 0
unappliedPaymentAmount: 0
unappliedCreditMemoAmount: 0
contractedMrr: -900
reservedPaymentAmount: 900
- currency: EUR
balance: 0
totalInvoiceBalance: 0
totalDebitMemoBalance: 0
unappliedPaymentAmount: 0
unappliedCreditMemoAmount: 0
contractedMrr: -900
reservedPaymentAmount: -900
billToContact:
address1: ''
address2: ''
city: ''
country: null
county: null
fax: ''
firstName: Test
homePhone: ''
id: 2c9081a03c6d7b51013c6d7e46c80a17
lastName: Test
mobilePhone: ''
nickname: ''
otherPhone: ''
otherPhoneType: null
personalEmail: ''
state: ''
taxRegion: null
workEmail: contact@example.com
workPhone: ''
zipCode: ''
soldToContact:
address1: ''
address2: ''
city: ''
country: null
county: null
fax: ''
firstName: Test
homePhone: ''
id: 2c9081a03c6d7b51013c6d7e46cf0a18
lastName: Test
mobilePhone: ''
nickname: ''
otherPhone: ''
otherPhoneType: null
personalEmail: ''
state: ''
taxRegion: null
workEmail: contact@example.com
workPhone: ''
zipCode: ''
einvoiceProfile:
enabled: 'true'
businessName: legal business name
businessNumber: '20002039'
businessNumberSchemeId: 088
taxRegisterNumber: TAX393999
endpointId: 08992
endpointSchemeId: 088
success: true
description: ''
schema:
$ref: '#/definitions/GETAccountType'
put:
summary: Update an account
operationId: PUT_Account
description: 'Updates a customer account by specifying the account-key.
### Notes
1. Only the fields to be changed should be specified. Any field that is not included in the request body will not be changed.
2. If an empty field is submitted with this operation, the corresponding field in the account is emptied.
3. Email addresses: If no email addresses are specified, no change is made to the email addresses or to the email delivery preference. If either the **personalEmail** or **workEmail** of **billToContact** is specified (or both), the system updates the corresponding email address(es) and the email delivery preference is set to `true`. (In that case, emails go to the **workEmail** address, if it exists, or else the **personalEmail**.) On the other hand, if as a result of this call both of the email addresses for the account are empty, the email delivery preference is set to `false`.
4. The bill-to and sold-to contacts are separate data entities. If you select the **Same as Bill To Contact** check box during account creation, both the Bill To and Sold To contacts are updated upon updating either one because they point to the same contact record. In this case, if you want to update only one of them, you have to first create another contact and update the Bill To or Sold To contact of the customer account to be the newly created one.
'
tags:
- Accounts
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: account-key
in: path
required: true
type: string
description: Account number or account ID.
- name: Request
in: body
description: ''
required: true
schema:
$ref: '#/definitions/PUTAccountType'
responses:
'200':
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
examples:
application/json:
success: true
description: ''
schema:
$ref: '#/definitions/CommonResponseType'
delete:
summary: Delete an account
operationId: DELETE_Account
description: "Deletes a specific account asynchronously. \n\n**Notes and Limitations:** \n- For account deletion, the system will start a backend job to remove all transactions under the accounts and change the status of the accounts to 'Cancelled'. This backend job is asynchronous and will take some time, depending on the job size. \n- An account cannot be deleted when the account is either the invoice owner or the subscription owner of a subscription and the subscription's invoice owner and subscription owner are two different accounts. An exception to this limitation is if the Enable Force Deletion for Account? setting is set to `Yes`, you can force delete an account that is the subscription owner of a subscription while the invoice owner is a different account. Force deleting this account deletes all its subscriptions, but the relevant invoices will not be impacted.\n- An account cannot be deleted if this account has ever been involved in an Owner Transfer amendment or order action, either as the current owner or as the previous owner. \n"
tags:
- Accounts
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: account-key
in: path
description: Account number or account ID.
required: true
type: string
responses:
'200':
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
examples:
application/json:
id: 40288ae9600808280160081dc9c13f15
jobId: 40288ae9600808280160081db1533506
jobStatus: Pending
success: true
description: ''
schema:
$ref: '#/definitions/DeleteAccountResponseType'
/v1/accounts/{account-key}/summary:
get:
summary: Retrieve an account summary
operationId: GET_AccountSummary
description: "Retrieves detailed information about the specified customer account.\n\nThe response includes the account information and a summary of the account’s subscriptions, invoices, payments, and usages.\n\n### Notes\nReturns only the six most recent subscriptions based on the subscription updatedDate. Within those subscriptions, there may be many rate plans and many rate plan charges. These items are subject to the maximum limit on the array size. \n"
tags:
- Accounts
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: account-key
in: path
required: true
type: string
description: Account number or account ID.
- name: excludeUsage
in: query
required: false
type: boolean
description: Indicate whether to exclude usage information in the response. The default value is `false`.
responses:
'200':
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
examples:
application/json:
payments:
- paidInvoices:
- invoiceNumber: INV00000159
appliedPaymentAmount: 5.0
invoiceId: 2c92a09539190dbe0139190f42780012
- invoiceNumber: INV00000323
appliedPaymentAmount: 139722.1
invoiceId: 2c92a0953a3fa95d013a407c10a60100
- invoiceNumber: INV00000160
appliedPaymentAmount: 10521.0
invoiceId: 2c92a09739190dc60139194bcf1b0098
paymentNumber: P-00000075
status: Processed
effectiveDate: '2013-03-27'
id: 2c92c8f83dabf9cf013daf3bfa0305a6
paymentType: Electronic
- paidInvoices:
- invoiceNumber: INV00000159
appliedPaymentAmount: 5.0
invoiceId: 2c92a09539190dbe0139190f42780012
paymentNumber: P-00000056
status: Processed
effectiveDate: '2012-08-11'
id: 2c92a0f9391832b101391922ad5f049d
paymentType: Electronic
invoices:
- amount: 139722.1
status: Posted
invoiceNumber: INV00000323
invoiceDate: '2013-02-11'
balance: 0.0
id: 2c92a0953a3fa95d013a407c10a60100
dueDate: '2013-02-11'
- amount: 10521.0
status: Posted
invoiceNumber: INV00000160
invoiceDate: '2012-08-11'
balance: 0.0
id: 2c92a09739190dc60139194bcf1b0098
dueDate: '2012-08-11'
- amount: 10.0
status: Posted
invoiceNumber: INV00000159
invoiceDate: '2012-08-11'
balance: 0.0
id: 2c92a09539190dbe0139190f42780012
dueDate: '2012-08-11'
usage:
- unitOfMeasure: UOM
quantity: 10.0
startDate: 2012-02
- unitOfMeasure: UOM
quantity: 10.0
startDate: 2012-01
basicInfo:
defaultPaymentMethod:
creditCardNumber: '************1111'
paymentMethodType: CreditCard
creditCardExpirationMonth: 10
creditCardExpirationYear: 2020
creditCardType: Visa
id: 2c92c8f83dabf9cf013daef12dd303b0
autoPay: true
status: Active
lastInvoiceDate: '2013-02-11'
lastPaymentAmount: 150248.1
billCycleDay: 1
invoiceDeliveryPrefsPrint: false
invoiceDeliveryPrefsEmail: true
additionalEmailAddresses:
- contact1@example.com
- contact2@example.com
name: subscribeCallYan_1
balance: 0.0
accountNumber: A00001115
id: 2c92a0f9391832b10139183e277a0042
currency: USD
lastPaymentDate: '2013-03-27'
partnerAccount: false
soldToContact:
fax: ''
taxRegion: ''
country: United States
zipCode: '95135'
county: ''
lastName: Cho
workEmail: contact@example.com
state: California
address2: ''
address1: 278 Bridgeton Circle
firstName: Bill
id: 2c92a0f9391832b10139183e27940043
workPhone: '5555551212'
city: San Jose
success: true
subscriptions:
- termEndDate: '2014-02-01'
termStartDate: '2013-02-01'
status: Active
initialTerm: 12
autoRenew: true
subscriptionNumber: A-S00001081
subscriptionStartDate: '2013-02-01'
id: 2c92c8f83dc4f752013dc72c24ee016d
ratePlans:
- productName: Recurring Charge
ratePlanName: QSF_Tier
termType: TERMED
renewalTerm: 3
- termEndDate: '2014-02-01'
termStartDate: '2013-02-01'
status: Active
initialTerm: 12
autoRenew: true
subscriptionNumber: A-S00001080
subscriptionStartDate: '2013-02-01'
id: 2c92c8f83dc4f752013dc72bb85c0127
ratePlans:
- productName: Recurring Charge
ratePlanName: QSF_Tier
termType: TERMED
renewalTerm: 3
- termEndDate: '2014-04-01'
termStartDate: '2013-12-01'
status: Cancelled
initialTerm: 10
autoRenew: false
subscriptionNumber: A-S00001079
subscriptionStartDate: '2013-02-01'
id: 2c92c8f83dc4f752013dc723fdab00d4
ratePlans:
- productName: Recurring Charge
ratePlanName: QSF_Tier
termType: TERMED
renewalTerm: 4
- termEndDate: '2012-02-11'
termStartDate: '2011-02-11'
status: Active
initialTerm: 12
autoRenew: false
subscriptionNumber: A-S00001076
subscriptionStartDate: '2011-02-11'
id: 2c92c8f83db0b4b4013db4717ad000ec
ratePlans:
- productName: Recurring Charge
ratePlanName: Month_PerUnit
- productName: Recurring Charge
ratePlanName: Month_PerUnit
termType: TERMED
renewalTerm: 3
- termEndDate: '2012-02-11'
termStartDate: '2011-02-11'
status: Active
initialTerm: 12
autoRenew: false
subscriptionNumber: A-S00001075
subscriptionStartDate: '2011-02-11'
id: 2c92c8f83db0b4b4013db3ab6a4d00bc
ratePlans:
- productName: Recurring Charge
ratePlanName: Month_PerUnit
- productName: Recurring Charge
ratePlanName: Month_PerUnit
termType: TERMED
renewalTerm: 3
- termEndDate: '2012-02-11'
termStartDate: '2011-02-11'
status: Active
initialTerm: 12
autoRenew: false
subscriptionNumber: A-S00001074
subscriptionStartDate: '2011-02-11'
id: 2c92c8f83db0b4b4013db3aa9fbd0090
ratePlans:
- productName: Recurring Charge
ratePlanName: Month_PerUnit
termType: TERMED
renewalTerm: 3
billToContact:
fax: ''
taxRegion: ''
country: United States
zipCode: '95135'
county: ''
lastName: Zou
workEmail: contact@example.com
state: California
address2: ''
address1: 1400 Bridge Pkwy
firstName: Cheng
id: 2c92a0f9391832b10139183e27940043
workPhone: '5555551212'
city: San Jose
description: ''
schema:
$ref: '#/definitions/GETAccountSummaryType'
/v1/accounts/{account-key}/payment-methods:
get:
summary: List payment methods of an account
operationId: GET_AcountPaymentMethods
description: 'Retrieves the payment methods of the specified customer account.
**Note:** This operation also supports retrieving custom payment methods created through the [Open Payment Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) service.
'
tags:
- Accounts
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: account-key
in: path
description: Account number or account ID.
required: true
type: string
- name: isDefaultOnly
in: query
required: false
type: boolean
description: Indicates whether to only retrieve the default payment method of the account. The default value is `false`. If this parameter is set to `true`, only the default payment method is retrieved.
- name: isActiveOnly
in: query
required: false
type: boolean
description: Indicates whether to only retrieve the active payment methods of the account. The default value is `false`. If this parameter is set to `true`, only the active payment methods are retrieved.
responses:
'200':
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
examples:
application/json:
defaultPaymentMethodId: 4028839f7d26a155017d26af16ef0001
paymentGateway: null
creditcard:
- cardNumber: '************1111'
expirationMonth: 11
expirationYear: 2027
creditCardType: Visa
accountHolderInfo:
accountHolderName: John Smith
phone: '86123456789'
email: example@google.com
addressLine1: ABC
addressLine2: EFT
zipCode: '123456'
city: Example City
country: United States
state: Example State
mandateInfo:
mitProfileAction: null
mitProfileType: null
mitConsentAgreementSrc: null
mitConsentAgreementRef: null
mitTransactionId: null
mitProfileAgreedOn: null
id: 4028839f7d26a155017d26af16ef0001
type: CreditCard
isDefault: true
accountKey: 4028839f7ca29000017ca29c1ce8003f
status: Active
lastTransaction: Approved
useDefaultRetryRule: true
bankIdentificationNumber: '411111'
deviceSessionId: null
existingMandate: null
ipAddress: null
lastFailedSaleTransactionDate: null
lastTransactionDateTime: '2021-11-15 18:59:08'
lastTransactionStatus: Approved
maxConsecutivePaymentFailures: null
numConsecutiveFailures: 0
paymentRetryWindow: null
totalNumberOfProcessedPayments: 0
totalNumberOfErrorPayments: 0
createdDate: '2021-11-15 18:59:08'
updatedDate: '2021-11-15 18:59:08'
createdBy: 402881e522cf4f9b0122cf5d82860002
updatedBy: 402881e522cf4f9b0122cf5d82860002
AA_PICKLIST__c: null
debitcard:
- cardNumber: '************8888'
expirationMonth: 11
expirationYear: 2021
creditCardType: Electron
accountHolderInfo:
accountHolderName: John Smith
phone: ''
email: smith@example.com
addressLine1: 1051 E Hillsdale Blvd
addressLine2: ''
zipCode: '45101'
city: Tynan
country: United States
state: California
mandateInfo:
mitProfileAction: null
mitProfileType: null
mitConsentAgreementSrc: null
mitConsentAgreementRef: null
mitTransactionId: null
mitProfileAgreedOn: null
id: 4028839f7cd92a6b017cda4defd00006
type: CreditCard
isDefault: false
accountKey: 4028839f7ca29000017ca29c1ce8003f
status: Active
lastTransaction: Approved
useDefaultRetryRule: true
bankIdentificationNumber: '588888'
deviceSessionId: null
existingMandate: null
ipAddress: null
lastFailedSaleTransactionDate: null
lastTransactionDateTime: '2021-11-01 00:01:53'
lastTransactionStatus: Approved
maxConsecutivePaymentFailures: null
numConsecutiveFailures: 0
paymentRetryWindow: null
totalNumberOfProcessedPayments: 0
totalNumberOfErrorPayments: 0
createdDate: '2021-11-01 00:01:52'
updatedDate: '2021-11-01 00:01:52'
createdBy: 402881e522cf4f9b0122cf5d82860002
updatedBy: 402881e522cf4f9b0122cf5d82860002
AA_PICKLIST__c: null
creditcardreferencetransaction:
- tokenId: ABCE
secondTokenId: FGDSDF
id: 4028839f7ce8c530017ce9725e2c0003
type: CreditCardReferenceTransaction
isDefault: false
accountKey: 4028839f7ca29000017ca29c1ce8003f
status: Active
lastTransaction: Approved
useDefaultRetryRule: true
bankIdentificationNumber: null
deviceSessionId: null
existingMandate: null
ipAddress: null
lastFailedSaleTransactionDate: null
lastTransactionDateTime: '2021-11-03 22:35:59'
lastTransactionStatus: Approved
maxConsecutivePaymentFailures: null
numConsecutiveFailures: 0
paymentRetryWindow: null
totalNumberOfProcessedPayments: 0
totalNumberOfErrorPayments: 0
createdDate: '2021-11-03 22:35:59'
updatedDate: '2021-11-03 22:35:59'
createdBy: 402881e522cf4f9b0122cf5d82860002
updatedBy: 402881e522cf4f9b0122cf5d82860002
AA_PICKLIST__c: null
cardNumber: null
expirationMonth: 11
expirationYear: 2021
creditCardType: Visa
accountHolderInfo:
accountHolderName: ''
phone: null
email: ''
addressLine1: ''
addressLine2: ''
zipCode: ''
city: ''
country: null
state: ''
mandateInfo:
mitProfileAction: null
mitProfileType: null
mitConsentAgreementSrc: null
mitConsentAgreementRef: null
mitTransactionId: null
mitProfileAgreedOn: null
ach:
- bankABACode: '110000000'
bankAccountNumber: '********6789'
bankAccountType: Checking
bankName: Chase
bankAccountName: Test
accountHolderInfo:
accountHolderName: null
phone: '2554444'
email: test@test.com
addressLine1: DSDFD
addressLine2: ''
zipCode: '123456'
city: Example City
country: United States
state: Example State
mandateInfo:
mandateId: null
mandateReceivedStatus: null
existingMandateStatus: null
mandateCreationDate: null
mandateUpdateDate: null
mandateStatus: null
mandateReason: null
id: 4028839f7cc14262017cc1bca9eb0008
type: ACH
isDefault: false
accountKey: 4028839f7ca29000017ca29c1ce8003f
status: Active
lastTransaction: Approved
useDefaultRetryRule: true
bankIdentificationNumber: null
deviceSessionId: null
existingMandate: null
ipAddress: null
lastFailedSaleTransactionDate: null
lastTransactionDateTime: '2021-10-27 05:32:19'
lastTransactionStatus: Approved
maxConsecutivePaymentFailures: null
numConsecutiveFailures: 0
paymentRetryWindow: null
totalNumberOfProcessedPayments: 0
totalNumberOfErrorPayments: 0
createdDate: '2021-10-27 05:32:19'
updatedDate: '2021-11-10 00:50:12'
createdBy: 402881e522cf4f9b0122cf5d82860002
updatedBy: 402881e522cf4f9b0122cf5d82860002
AA_PICKLIST__c: null
success: true
description: ''
schema:
$ref: '#/definitions/GETAccountPaymentMethodType'
/v1/accounts/{account-key}/payment-methods/default:
get:
summary: Retrieve the default payment method of an account
operationId: GET_AcountDefaultPaymentMethod
description: 'Retrieves the default payment method of the specified customer account.
**Note:** This operation also supports retrieving the custom payment method created through the [Open Payment Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) service.
'
tags:
- Accounts
parameters:
- $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- name: account-key
in: path
description: Account number or account ID.
required: true
type: string
responses:
'200':
headers:
Content-Encoding:
type: string
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
RateLimit-Limit:
type: string
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Remaining:
type: number
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
RateLimit-Reset:
type: number
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
Zuora-Request-Id:
type: string
minLength: 36
maxLength: 36
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
Zuora-Track-Id:
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
examples:
application/json:
cardNumber: '************1111'
expirationMonth: 11
expirationYear: 2027
creditCardType: Visa
accountHolderInfo:
accountHolderName: John Smith
phone: '86123456789'
email: example@google.com
addressLine1: ABC
addressLine2: EFT
zipCode: '844000'
city: Example City
country: United States
state: Example State
mandateInfo:
mitProfileAction: null
mitProfileType: null
mitConsentAgreementSrc: null
mitConsentAgreementRef: null
mitTransactionId: null
mitProfileAgreedOn: null
id: 4028839f7d26a155017d26af16ef0001
type: CreditCard
isDefault: true
accountKey: 4028839f7ca29000017ca29c1ce8003f
status: Active
lastTransaction: Approved
useDefaultRetryRule: true
bankIdentificationNumber: '411111'
deviceSessionId: null
existingMandate: null
ipAddress: null
lastFailedSaleTransactionDate: null
lastTransactionDateTime: '2021-11-15 18:59:08'
lastTransactionStatus: Approved
maxConsecutivePaymentFailures: null
numConsecutiveFailures: 0
paymentRetryWindow: null
totalNumberOfProcessedPayments: 0
totalNumberOfErrorPayments: 0
createdDate: '2021-11-15 18:59:08'
updatedDate: '2021-11-15 18:59:08'
createdBy: 402881e522cf4f9b0122cf5d82860002
updatedBy: 402881e522cf4f9b0122cf5d82860002
AA_PICKLIST__c: null
success: true
description: ''
schema:
$ref: '#/definitions/GETPaymentMethodResponseForAccount'
definitions:
GETAccountCurrencyMetricsType:
allOf:
- properties:
balance:
description: 'The total balance in this currency.
'
type: string
contractedMrr:
description: 'The future expected Monthly Recurring Revenue (MRR) in this currency, accounting for future upgrades, downgrades, upsells, and cancellations.
'
format: decimal
type: string
currency:
description: 'The currency that metrics are aggregated based on.
'
type: string
reservedPaymentAmount:
description: 'The reserved payment amount of the customer account in this currency. For more information, see Prepaid Cash with Drawdown.
'
format: decimal
type: string
totalDebitMemoBalance:
description: 'The total balance of all posted debit memos in this currency.
**Note:** This field is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.
'
format: decimal
type: string
totalInvoiceBalance:
description: 'The total balance of all posted invoices in this currency.
'
format: decimal
type: string
unappliedCreditMemoAmount:
description: 'The total unapplied amount of all posted credit memos in this currency.
'
format: decimal
type: string
unappliedPaymentAmount:
description: 'The total unapplied amount of all posted payments in this currency.
**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.
'
format: decimal
type: string
type: object
title: metricsData
POSTAccountTypeSoldToContact:
allOf:
- properties:
address1:
description: 'First address line, 255 characters or less.
'
type: string
address2:
description: 'Second address line, 255 characters or less.
'
type: string
city:
description: 'City, 40 characters or less.
'
type: string
country:
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.
'
type: string
county:
description: 'County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax.
'
type: string
fax:
description: 'Fax phone number, 40 characters or less.
'
type: string
firstName:
description: 'First name, 100 characters or less.
'
type: string
homePhone:
description: 'Home phone number, 40 characters or less.
'
type: string
lastName:
description: 'Last name, 100 characters or less.
'
type: string
mobilePhone:
description: 'Mobile phone number, 40 characters or less.
'
type: string
nickname:
description: 'Nickname for this contact
'
type: string
otherPhone:
description: 'Other phone number, 40 characters or less.
'
type: string
otherPhoneType:
description: 'Possible values are: `Work`, `Mobile`, `Home`, `Other`.
'
type: string
personalEmail:
description: 'Personal email address, 80 characters or less.
'
type: string
state:
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.
'
type: string
taxRegion:
description: 'If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.
'
type: string
workEmail:
description: 'Work email address, 80 characters or less.
'
type: string
workPhone:
description: 'Work phone number, 40 characters or less.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
required:
- firstName
- lastName
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
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.
'
title: soldToContact
POSTAccountTypePaymentMethod:
allOf:
- properties:
type:
description: 'Type of payment method. Possible values include:
* `CreditCard` - Credit card payment method.
* `CreditCardReferenceTransaction` - Credit Card Reference Transaction. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods) for payment gateways that support this type of payment method.
* `ACH` - ACH payment method.
* `SEPA` - Single Euro Payments Area.
* `Betalingsservice` - Direct Debit DK.
* `Autogiro` - Direct Debit SE.
* `Bacs` - Direct Debit UK.
* `Becs` - Direct Entry AU.
* `Becsnz` - Direct Debit NZ.
* `PAD` - Pre-Authorized Debit.
* `PayPalCP` - PayPal Commerce Platform payment method. Use this type if you are using a [PayPal Commerce Platform Gateway](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Commerce_Platform_Gateway) instance.
* `PayPalEC` - PayPal Express Checkout payment method. Use this type if you are using a [PayPal Payflow Pro Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Payflow_Pro%2C_Website_Payments_Payflow_Edition%2C_Website_Pro_Payment_Gateway) instance.
* `PayPalNativeEC` - PayPal Native Express Checkout payment method. Use this type if you are using a [PayPal Express Checkout Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Express_Checkout_Gateway) instance.
* `PayPalAdaptive` - PayPal Adaptive payment method. Use this type if you are using a [PayPal Adaptive Payment Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Adaptive_Payments_Gateway) instance.
* `AdyenApplePay` - Apple Pay on Adyen Integration v2.0. 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) for details.
* `AdyenGooglePay` - Google Pay on Adyen Integration v2.0. 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) for details.
* `GooglePay` - Google Pay on Chase Paymentech Orbital gateway integration. 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) for details.
* You can also specify a custom payment method type. See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) for details.
'
type: string
required:
- type
type: object
- $ref: '#/definitions/CreatePMPayPalECPayPalNativeECPayPalCP'
- $ref: '#/definitions/CreatePaymentMethodPayPalAdaptive'
- $ref: '#/definitions/CreatePaymentMethodCreditCard'
- $ref: '#/definitions/CreatePaymentMethodACH'
- $ref: '#/definitions/CreatePaymentMethodCommon'
- $ref: '#/definitions/PaymentMethodObjectCustomFields'
- $ref: '#/definitions/CreatePaymentMethodBankTransfer'
- $ref: '#/definitions/CreatePaymentMethodCCReferenceTransaction'
- $ref: '#/definitions/CreatePaymentMethodApplePayAdyen'
- $ref: '#/definitions/CreatePaymentMethodGooglePayAdyenChase'
description: 'Container for information on payment methods to associate with this account. To associate a credit card payment method when creating an account, Zuora recommends that you use this field instead of the `creditCard` field.
Note that you can not use this field together with `creditCard` or `hpmCreditCardPaymentMethodId` to associate a payment method to an account.
'
title: paymentMethod
AccountObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Account object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of an Account object.
'
title: accountFieldsCustom
type: object
GETAccountPMAccountHolderInfo:
description: 'The account holder information.
'
properties:
accountHolderName:
description: 'The full name of the account holder.
'
maxLength: 60
type: string
addressLine1:
description: 'The first line of the address for the account holder.
'
type: string
addressLine2:
description: "The second line of the address for the account holder. \n"
type: string
city:
description: "The city where the account holder stays. \n"
type: string
country:
description: 'The country where the account holder stays.
When 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 country name listed in [Country Names and Their ISO Standard 2- and 3-Digit Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/A_Country_Names_and_Their_ISO_Codes) returns in this field. Internationalization is not supported for the API field value.
'
type: string
email:
description: 'The email address of the account holder.
'
type: string
phone:
description: 'The phone number of the account holder.
'
type: string
state:
description: 'The state where the account holder stays.
'
type: string
zipCode:
description: 'The zip code for the address of the account holder.
'
type: string
title: accountHolderInfo
type: object
SubscriptionObjectQTFields:
description: 'Container for Subscription fields provided by Zuora Quotes.
'
properties:
CpqBundleJsonId__QT:
description: 'The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field.
'
maxLength: 32
type: string
OpportunityCloseDate__QT:
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.
'
format: date
type: string
OpportunityName__QT:
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.
'
maxLength: 100
type: string
QuoteBusinessType__QT:
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.
'
maxLength: 32
type: string
QuoteNumber__QT:
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.
'
maxLength: 32
type: string
QuoteType__QT:
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.
'
maxLength: 32
type: string
title: subscriptionFieldsQT
type: object
AccountObjectNSFields:
description: 'Container for Account fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
properties:
Class__NS:
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).
'
maxLength: 255
type: string
CustomerType__NS:
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).
'
enum:
- Company
- Individual
type: string
Department__NS:
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).
'
maxLength: 255
type: string
IntegrationId__NS:
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).
'
maxLength: 255
type: string
IntegrationStatus__NS:
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).
'
maxLength: 255
type: string
Location__NS:
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).
'
maxLength: 255
type: string
Subsidiary__NS:
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).
'
maxLength: 255
type: string
SyncDate__NS:
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).
'
maxLength: 255
type: string
SynctoNetSuite__NS:
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).
'
enum:
- 'Yes'
- 'No'
type: string
title: accountFieldsNetSuite
type: object
CommonResponseType:
properties:
processId:
description: 'The Id of the process that handle the operation.
'
type: string
reasons:
items:
properties:
code:
description: 'The error code of response.
'
type: string
message:
description: 'The detail information of the error response
'
type: string
type: object
type: array
success:
description: 'Indicates whether the call succeeded.
'
type: boolean
type: object
POSTScCreateType:
allOf:
- properties:
amendedByOrderOn:
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.
'
type: string
applyDiscountTo:
description: 'Specifies the type of charges that you want a specific discount to apply to.
Values:
* `ONETIME`
* `RECURRING`
* `USAGE`
* `ONETIMERECURRING`
* `ONETIMEUSAGE`
* `RECURRINGUSAGE`
* `ONETIMERECURRINGUSAGE`
'
type: string
billCycleDay:
description: 'Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month the customer is billed.
Values: `1`-`31`
'
type: string
billCycleType:
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.
Values:
* `DefaultFromCustomer`
* `SpecificDayofMonth`
* `SubscriptionStartDay`
* `ChargeTriggerDay`
* `SpecificDayofWeek`
'
type: string
billingPeriod:
description: 'Billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD).
Values:
* `Month`
* `Quarter`
* `Semi_Annual`
* `Annual`
* `Eighteen_Months`
* `Two_Years`
* `Three_Years`
* `Five_Years`
* `Specific_Months`
* `Subscription_Term`
* `Week`
* `Specific_Weeks`
'
type: string
billingPeriodAlignment:
description: 'Aligns charges within the same subscription if multiple charges begin on different dates.
Values:
* `AlignToCharge`
* `AlignToSubscriptionStart`
* `AlignToTermStart`
'
type: string
billingTiming:
description: 'Billing timing for the charge for recurring charge types. Not avaliable for one time, usage, and discount charges.
Values:
* `IN_ADVANCE` (default)
* `IN_ARREARS`
'
type: string
chargeModelConfiguration:
$ref: '#/definitions/ChargeModelConfigurationType'
description:
description: 'Description of the charge.
'
type: string
discountAmount:
description: 'Specifies the amount of fixed-amount discount.
'
type: number
discountLevel:
description: 'Specifies if the discount applies to the product rate plan only, the entire subscription, or to any activity in the account.
Values:
* `rateplan`
* `subscription`
* `account`
'
type: string
discountPercentage:
description: "Percentage of discount for a percentage discount. \n"
type: number
endDateCondition:
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.
Values:
* `Subscription_End`
* `Fixed_Period`
* `Specific_End_Date`
* `One_Time`
'
type: string
excludeItemBillingFromRevenueAccounting:
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.
**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.
'
type: boolean
excludeItemBookingFromRevenueAccounting:
default: false
description: 'The flag to exclude rate plan charges from revenue accounting.
**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.
'
type: boolean
includedUnits:
description: 'Specifies the number of units in the base set of units for this charge. Must be >=`0`.
'
type: number
isAllocationEligible:
description: 'This field is used to identify if the charge segment is allocation eligible in revenue recognition.
**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.
'
type: boolean
isUnbilled:
description: 'This field is used to dictate how to perform the accounting during revenue recognition.
**Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.
'
type: boolean
listPriceBase:
description: 'The list price base for the product rate plan charge.
Values:
* `Per_Billing_Period`
* `Per_Month`
* `Per_Week`
* `Per_Year`
* `Per_Specific_Months`
'
type: string
number:
description: 'Unique number that identifies the charge. Max 50 characters. System-generated if not provided.
'
type: string
numberOfPeriods:
description: 'Specifies the number of periods to use when calculating charges in an overage smoothing charge model.
'
format: int64
type: integer
originalOrderDate:
description: 'The date when the rate plan charge is created through an order or amendment. This field is not updatable.
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.
'
format: date
type: string
overagePrice:
description: 'Price for units over the allowed amount.
'
type: number
overageUnusedUnitsCreditOption:
description: 'Determines whether to credit the customer with unused units of usage.
Values:
* `NoCredit`
* `CreditBySpecificRate`
'
type: string
price:
description: 'Price for units in the subscription rate plan.
'
type: number
priceChangeOption:
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.
Values:
* `NoChange` (default)
* `SpecificPercentageValue`
* `UseLatestProductCatalogPricing`
'
type: string
priceIncreasePercentage:
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"
type: number
productRatePlanChargeId:
description: 'ID of a product rate-plan charge for this subscription.
'
type: string
productRatePlanChargeNumber:
description: 'Number of a product rate-plan charge for this subscription.
'
type: string
quantity:
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"
type: number
ratingGroup:
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"
type: string
specificBillingPeriod:
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`.
'
format: int64
type: integer
specificEndDate:
description: 'Defines when the charge ends after the charge trigger date.
**note:**
* This field is only applicable when the `endDateCondition` field is set to `Specific_End_Date`.
* 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.
'
format: date
type: string
specificListPriceBase:
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 Annual List Price 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"
format: int32
maximum: 200
minimum: 1
type: integer
tiers:
description: 'Container for Volume, Tiered, or Tiered with Overage charge models. Supports the following charge types:
* One-time
* Recurring
* Usage-based
'
items:
$ref: '#/definitions/POSTTierType'
type: array
triggerDate:
description: 'Specifies when to start billing the customer for the charge. Required if the `triggerEvent` field is set to `USD`.
'
format: date
type: string
triggerEvent:
description: 'Specifies when to start billing the customer for the charge.
Values:
* `UCE`
* `USA`
* `UCA`
* `USD`
'
type: string
unusedUnitsCreditRates:
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`.
'
type: number
upToPeriods:
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"
format: int64
type: integer
upToPeriodsType:
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"
type: string
weeklyBillCycleDay:
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"
type: string
required:
- productRatePlanChargeId
type: object
- $ref: '#/definitions/RatePlanChargeObjectCustomFields'
title: chargeOverrides
CreatePaymentMethodACH:
properties:
addressLine1:
description: 'First address line, 255 characters or less.
'
type: string
addressLine2:
description: 'Second address line, 255 characters or less.
'
type: string
bankABACode:
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`.
'
type: string
bankAccountName:
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`.
For 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.
'
maxLength: 70
type: string
bankAccountNumber:
description: 'The bank account number associated with the ACH payment. This field is only required if the `type` field is set to `ACH`.
'
maxLength: 30
type: string
bankAccountType:
description: 'The type of bank account associated with the ACH payment. This field is only required if the `type` field is set to `ACH`.
When 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.
'
enum:
- BusinessChecking
- BusinessSaving
- Checking
- Saving
type: string
bankName:
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`.
When 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.
'
maxLength: 70
type: string
city:
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: string
country:
description: 'Country, must be a valid country name or abbreviation.
See [Country Names and Their ISO Standard 2- and 3-Digit Codes](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Country%2C_State%2C_and_Province_Codes/A_Country_Names_and_Their_ISO_Codes) for the list of supported country names and abbreviations.
It 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.
'
type: string
phone:
description: 'Phone number, 40 characters or less.
'
type: string
state:
description: 'State, must be a valid state name or 2-character abbreviation.
See [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.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
type: object
customAccountPaymentMethod:
additionalProperties:
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.
**Note:** The response could return more than one custom payment methods.
'
title: Custom Payment Method
type: object
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.
**Note:** The response could return more than one custom payment methods.
'
title: CustomPaymentMethod
type: object
GetAccountEInvoiceProfile:
description: 'Container for e-invoicing profile information for this account.
**Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.
'
properties:
businessName:
description: 'The full official name that the Buyer is registered with the relevant legal authority.
'
maxLength: 255
type: string
businessNumber:
description: 'The unique identifier number of the legal entity or person that you do business with.
For example, you must use a GSTIN for India.
'
type: string
businessNumberSchemeId:
description: 'The identification scheme identifier that an official registrar issues to identify the Buyer as a legal entity or person.
'
type: string
enabled:
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"
type: boolean
endpointId:
description: 'The Buyer''s electronic address, to which the application-level response to the billing document might be delivered.
'
type: string
endpointSchemeId:
description: 'The identification scheme identifier of the Buyer’s electronic address.
'
type: string
taxRegisterNumber:
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.
'
type: string
title: einvoiceProfile
type: object
ChargeModelConfigurationType:
description: 'Container for charge model configuration data.
**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.
'
properties:
customFieldPerUnitRate:
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"
type: string
customFieldTotalAmount:
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"
type: string
formula:
description: 'The pricing formula to calculate actual rating amount for each usage record.
This 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.
'
type: string
title: chargeModelConfiguration
type: object
SubscriptionObjectNSFields:
description: 'Container for Subscription fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
'
properties:
IntegrationId__NS:
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).
'
maxLength: 255
type: string
IntegrationStatus__NS:
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).
'
maxLength: 255
type: string
Project__NS:
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).
'
maxLength: 255
type: string
SalesOrder__NS:
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).
'
maxLength: 255
type: string
SyncDate__NS:
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).
'
maxLength: 255
type: string
title: subscriptionFieldsNS
type: object
GETAccountSummaryTypeSoldToContact:
allOf:
- properties:
address1:
description: 'First address line, 255 characters or less.
'
type: string
address2:
description: 'Second address line, 255 characters or less.
'
type: string
city:
description: 'City, 40 characters or less.
'
type: string
country:
description: 'Full country name. This field does not contain the ISO-standard abbreviation of the country name.
'
type: string
county:
description: 'County; 32 characters or less. Zuora Tax uses this information to calculate county taxation. '
type: string
fax:
description: 'Fax phone number, 40 characters or less.
'
type: string
firstName:
description: 'First name, 100 characters or less.
'
type: string
id:
description: 'Contact ID.
'
type: string
lastName:
description: 'Last name, 100 characters or less.
'
type: string
state:
description: 'Full state name. This field does not contain the ISO-standard abbreviation of the state name.
'
type: string
taxRegion:
description: 'A region string, defined in your Zuora tax rules.
'
type: string
workEmail:
description: 'Work email address, 80 characters or less.
'
type: string
workPhone:
description: 'Work phone number, 40 characters or less.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
description: "Container for sold-to contact information.\n\n**Note**: \n - If you have the 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 - 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"
title: Contact
ContactObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Contact object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of a Contact object.
'
title: contactFieldsCustom
type: object
POSTAccountPMMandateInfo:
description: 'The mandate information for the Credit Card, Apple Pay, Google Pay, Credit Card Reference Transaction, ACH, or Bank Transfer payment method.
The following mandate fields are common to all supported payment methods:
* `mandateId`
* `mandateReason`
* `mandateStatus`
The following mandate fields are specific to the ACH and Bank Transfer payment methods:
* `mandateReceivedStatus`
* `existingMandateStatus`
* `mandateCreationDate`
* `mandateUpdateDate`
The following mandate fields are specific to the Credit Card, Apple Pay, and Google Pay payment methods:
* `mitTransactionId`
* `mitProfileAgreedOn`
* `mitConsentAgreementRef`
* `mitConsentAgreementSrc`
* `mitProfileType`
* `mitProfileAction`
'
properties:
existingMandateStatus:
description: 'Indicates whether the mandate is an existing mandate.
'
enum:
- 'Yes'
- 'No'
type: string
mandateCreationDate:
description: 'The date on which the mandate was created.
'
format: date
type: string
mandateId:
description: 'The mandate ID.
'
type: string
mandateReason:
description: 'The reason of the mandate from the gateway side.
'
type: string
mandateReceivedStatus:
description: 'Indicates whether the mandate is received from the gateway
'
enum:
- 'Yes'
- 'No'
type: string
mandateStatus:
description: 'The status of the mandate from the gateway side.
'
type: string
mandateUpdateDate:
description: 'The date on which the mandate was updated.
'
format: date
type: string
mitConsentAgreementRef:
description: "Reference for the consent agreement that you have established with the customer. \n"
type: string
mitConsentAgreementSrc:
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.
'
enum:
- External
type: string
mitProfileAction:
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"
enum:
- Activate
- Persist
type: string
mitProfileAgreedOn:
description: 'The date on which the stored credential profile is agreed. The date format is `yyyy-mm-dd`.
'
format: date
type: string
mitProfileType:
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.
'
type: string
mitTransactionId:
description: 'Specifies the ID of the transaction. Only applicable if you set the `mitProfileAction` field to `Persist`.
'
maxLength: 128
type: string
title: mandateInfo
type: object
GETAccountSummaryPaymentType:
properties:
effectiveDate:
description: 'Effective date as `yyyy-mm-dd`.
'
format: date
type: string
id:
description: 'Payment ID.
'
type: string
paidInvoices:
description: 'Container for paid invoices for this subscription.
'
items:
$ref: '#/definitions/GETAccountSummaryPaymentInvoiceType'
type: array
paymentNumber:
description: 'Payment number.
'
type: string
paymentType:
description: 'Payment type; possible values are: `External`, `Electronic`.
'
type: string
status:
description: 'Payment status. Possible values are: `Draft`, `Processing`, `Processed`, `Error`, `Voided`, `Canceled`, `Posted`.
'
type: string
title: payments
type: object
GETAccountSummaryInvoiceType:
properties:
amount:
description: 'Invoice amount before adjustments, discounts, and similar items.
'
type: number
balance:
description: 'Balance due on the invoice.
'
format: decimal
type: string
dueDate:
description: 'Due date as `yyyy-mm-dd`.
'
format: date
type: string
id:
description: 'Invoice ID.
'
type: string
invoiceDate:
description: 'Invoice date as `yyyy-mm-dd`.
'
format: date
type: string
invoiceNumber:
description: 'Invoice number.
'
type: string
status:
description: 'Invoice status - not the payment status of the invoice, just the status of the invoice itself. Possible values are: `Posted`, `Draft`, `Canceled`, `Error`.
'
type: string
title: invoices
type: object
POSTAccountType:
allOf:
- properties:
accountNumber:
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.
'
type: string
additionalEmailAddresses:
description: 'A list of additional email addresses to receive email notifications. Use commas to separate email addresses.
'
items:
type: string
type: array
applicationOrder:
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"
items:
type: string
type: array
applyCredit:
description: 'Whether to automatically apply credit memos or unapplied payments, or both to an invoice.
If 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.
**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.
'
type: boolean
applyCreditBalance:
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"
type: boolean
autoPay:
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"
type: boolean
batch:
description: 'The alias name given to a batch. A string of 50 characters or
less.
**Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package.
'
type: string
billCycleDay:
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"
format: int64
type: integer
billToContact:
$ref: '#/definitions/POSTAccountTypeBillToContact'
collect:
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](/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
type: boolean
communicationProfileId:
description: 'The ID of the communication profile that this account is linked to.
You can provide either or both of the `communicationProfileId` and `profileNumber` fields.
If both are provided, the request will fail if they do not refer to the same communication profile.
'
type: string
creditCard:
$ref: '#/definitions/POSTAccountTypeCreditCard'
creditMemoReasonCode:
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.
type: string
creditMemoTemplateId:
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.
The unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.
'
type: string
crmId:
description: 'CRM account ID for the account, up to 100 characters.
'
type: string
currency:
description: 'A currency as defined in Billing Settings in the Zuora UI.
For 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.
'
type: string
debitMemoTemplateId:
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.
The unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.
'
type: string
documentDate:
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"
format: date
type: string
einvoiceProfile:
$ref: '#/definitions/PostAccountEInvoiceProfile'
hpmCreditCardPaymentMethodId:
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.
If 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.
For 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.
'
type: string
invoice:
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"
type: boolean
invoiceCollect:
description: '**Note:** This field has been replaced by the `invoice` field
and the `collect` field. `invoiceCollect` is available only for backward
compatibility.
If 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.
**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`.
'
type: boolean
invoiceDeliveryPrefsEmail:
default: false
description: "Whether the customer wants to receive invoices through email. \n"
type: boolean
invoiceDeliveryPrefsPrint:
default: false
description: 'Whether the customer wants to receive printed invoices, such as through postal mail.
'
type: boolean
invoiceTargetDate:
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](/api-references/api/overview/#section/API-Versions/Minor-Version). \n"
format: date
type: string
invoiceTemplateId:
description: 'Invoice template ID, configured in Billing Settings in the Zuora UI.
'
type: string
name:
description: 'Account name, up to 255 characters.
'
type: string
notes:
description: A string of up to 65,535 characters.
type: string
organizationLabel:
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"
type: string
parentId:
description: Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have Customer Hierarchy enabled.
type: string
partnerAccount:
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 Reseller Account feature enabled.\n"
type: boolean
paymentGateway:
description: 'The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.
'
type: string
paymentMethod:
$ref: '#/definitions/POSTAccountTypePaymentMethod'
paymentTerm:
description: 'Payment terms for this account. Possible values are: `Due Upon Receipt`, `Net 30`, `Net 60`, `Net 90`.
**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.
'
type: string
profileNumber:
description: 'The number of the communication profile that this account is linked to.
You can provide either or both of the `communicationProfileId` and `profileNumber` fields.
If both are provided, the request will fail if they do not refer to the same communication profile.
'
type: string
runBilling:
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](/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"
enum:
- true
- false
type: boolean
salesRep:
description: The name of the sales representative associated with this account, if applicable. Maximum of 50 characters.
type: string
sequenceSetId:
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"
type: string
soldToContact:
$ref: '#/definitions/POSTAccountTypeSoldToContact'
soldToSameAsBillTo:
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"
type: boolean
subscription:
$ref: '#/definitions/POSTAccountTypeSubscription'
tagging:
description: ''
type: string
targetDate:
description: 'Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date.
**Note:** The credit memo is only available only if you have the Invoice Settlement feature enabled.
This field is in Zuora REST API version control. Supported minor versions are `211.0` and later [available versions](/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.
'
format: date
type: string
taxInfo:
description: 'Container for tax exempt information, used to establish the tax exempt status of a customer account.
'
properties:
VATId:
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"
type: string
companyCode:
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"
type: string
exemptCertificateId:
description: 'ID of the customer tax exemption certificate. Requires Zuora Tax.
'
type: string
exemptCertificateType:
description: 'Type of tax exemption certificate that the customer holds. Requires Zuora Tax.
'
type: string
exemptDescription:
description: 'Description of the tax exemption certificate that the customer holds. Requires Zuora Tax.
'
type: string
exemptEffectiveDate:
description: 'Date when the customer tax exemption starts. Requires Zuora Tax.
Format: `yyyy-mm-dd`. Defaults to the current date.
'
format: date
type: string
exemptEntityUseCode:
description: 'A unique entity use code to apply exemptions in Avalara AvaTax.
This 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.
'
maxLength: 64
type: string
exemptExpirationDate:
description: 'Date when the customer tax exemption expires. Requires Zuora Tax.
Format: `yyyy-mm-dd`. Defaults to the current date.
'
format: date
type: string
exemptIssuingJurisdiction:
description: 'Jurisdiction in which the customer tax exemption certificate was issued.
'
type: string
exemptStatus:
description: 'Status of the account tax exemption. Requires Zuora Tax.
Required if you use Zuora Tax. This field is unavailable if Zuora Tax is not used.
Values: `Yes`, `No`(default), `pendingVerification`. Note that the value will be set to `No` if no input.
'
type: string
type: object
required:
- name
- currency
- billToContact
type: object
- $ref: '#/definitions/AccountObjectNSFields'
- $ref: '#/definitions/AccountObjectCustomFields'
example:
additionalEmailAddresses:
- contact1@example.com
- contact2@example.com
autoPay: false
billCycleDay: 0
billToContact:
address1: 1051 E Hillsdale Blvd
city: Foster City
country: United States
firstName: John
lastName: Smith
state: CA
workEmail: smith@example.com
zipCode: '94404'
creditMemoReasonCode: Unsatisfactory service
currency: USD
einvoiceProfile:
businessName: legal business name
businessNumber: 20002039
businessNumberSchemeId: 088
enabled: true
endpointId: 08992
endpointSchemeId: 088
taxRegisterNumber: TAX393999
hpmCreditCardPaymentMethodId: 2c92c0f93cf64d94013cfe2d20db61a7
invoiceDeliveryPrefsEmail: true
invoiceDeliveryPrefsPrint: false
name: Zuora Test Account
notes: This account is for demo purposes.
partnerAccount: true
paymentTerm: Due Upon Receipt
subscription:
autoRenew: true
contractEffectiveDate: '2016-01-01'
initialTerm: 12
notes: This is a trial subscription for POST account demo.
renewalTerm: 12
subscribeToRatePlans:
- chargeOverrides:
- price: 1000
productRatePlanChargeId: 2c92c0f94ac8307f014ae5d4a5156b28
- price: 1000
productRatePlanChargeId: 2c92c0f94ac8307f014ae5dbe2947851
productRatePlanId: 2c92c0f94ac8307f014ae5d3d1d469e2
- chargeOverrides:
- price: 1000
productRatePlanChargeId: 2c92c0f83cf64298013d027725a67b7b
productRatePlanId: 2c92c0f93cf64d94013d027681560341
termType: TERMED
CreatePaymentMethodCreditCard:
properties:
cardHolderInfo:
$ref: '#/definitions/CreatePaymentMethodCardholderInfo'
cardNumber:
description: 'Credit card number. This field is required if `type` is set to `CreditCard`.
'
type: string
cardType:
description: 'The type of the credit card. This field is required if `type` is set to `CreditCard`.
Possible 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).
'
type: string
checkDuplicated:
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:\n ```\n ************1234\n ```\n"
type: boolean
expirationMonth:
description: 'One or two digit expiration month (1-12) of the credit card. This field is required if `type` is set to `CreditCard`.
'
type: integer
expirationYear:
description: 'Four-digit expiration year of the credit card. This field is required if `type` is set to `CreditCard`.
'
type: integer
mitConsentAgreementRef:
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.
'
maxLength: 128
type: string
mitConsentAgreementSrc:
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.
'
enum:
- External
type: string
mitNetworkTransactionId:
description: 'Specifies the ID of a network transaction. Only applicable if you set the `mitProfileAction` field to `Persist`.
'
maxLength: 128
type: string
mitProfileAction:
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"
enum:
- Activate
- Persist
type: string
mitProfileAgreedOn:
description: 'The date on which the profile is agreed. The date format is `yyyy-mm-dd`.
'
format: date
type: string
mitProfileType:
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.
'
enum:
- Recurring
- Unscheduled
type: string
screeningAmount:
description: 'For Chase Paymentech Orbital Gateway 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.
Two-decimal amount is supported.
If the `screeningAmount` field is not specified, the authorization amount is used for fraud screening.
'
format: decimal
type: number
securityCode:
description: 'CVV or CVV2 security code of the credit card.
To ensure PCI compliance, this value is not stored and cannot be queried.
'
type: string
type: object
CreatePaymentMethodCardholderInfo:
description: 'Container for cardholder information. This container field is required for credit card payment methods. The nested `cardHolderName` field is required.
'
properties:
addressLine1:
description: 'First address line, 255 characters or less.
'
type: string
addressLine2:
description: 'Second address line, 255 characters or less.
'
type: string
cardHolderName:
description: 'The card holder''s full name as it appears on the card, e.g., "John J Smith", 50 characters or less.
'
type: string
city:
description: 'City, 40 characters or less.
It 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.
'
type: string
country:
description: 'Country, must be a valid country name or abbreviation.
It 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.
'
type: string
email:
description: 'Card holder''s email address, 80 characters or less.
'
type: string
phone:
description: 'Phone number, 40 characters or less.
'
type: string
state:
description: 'State; must be a valid state name or 2-character abbreviation.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
required:
- cardHolderName
title: cardHolderInfo
type: object
CreatePMPayPalECPayPalNativeECPayPalCP:
properties:
BAID:
description: 'ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9.
'
type: string
email:
description: "Email address associated with the payment method. This field is supported for the following payment methods:\n - PayPal payment methods. This field is required for creating any of the following PayPal payment methods.\n - PayPal Express Checkout\n - PayPal Adaptive\n - PayPal Commerce Platform\n - Apple Pay and Google Pay payment methods on Adyen v2.0. This field will be passed to Adyen as `shopperEmail`.\n"
type: string
type: object
RatePlanObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Rate Plan object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of a Rate Plan object.
'
title: ratePlanFieldsCustom
type: object
POSTAccountResponseType:
properties:
accountId:
description: 'Auto-generated account ID.
'
type: string
accountNumber:
description: 'Account number.
'
type: string
billToContactId:
description: 'The ID of the bill-to contact.
'
type: string
contractedMrr:
description: 'Contracted monthly recurring revenue of the subscription.
'
format: decimal
type: string
creditMemoId:
description: 'The credit memo ID, if a credit memo is generated during the subscription process.
**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.
'
type: string
invoiceId:
description: 'ID of the invoice generated at account creation, if applicable.
'
type: string
paidAmount:
description: 'Amount collected on the invoice generated at account creation, if applicable.
'
format: decimal
type: string
paymentId:
description: 'ID of the payment collected on the invoice generated at account creation, if applicable.
'
type: string
paymentMethodId:
description: 'ID of the payment method that was set up at account creation, which automatically becomes the default payment method for this account.
'
type: string
soldToContactId:
description: 'The ID of the sold-to contact.
'
type: string
subscriptionId:
description: 'ID of the subscription that was set up at account creation, if applicable.
'
type: string
subscriptionNumber:
description: 'Number of the subscription that was set up at account creation, if applicable.
'
type: string
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
totalContractedValue:
description: 'Total contracted value of the subscription.
'
format: decimal
type: string
type: object
POSTAccountTypeBillToContact:
allOf:
- properties:
address1:
description: 'First address line, 255 characters or less.
'
type: string
address2:
description: 'Second address line, 255 characters or less.
'
type: string
city:
description: 'City, 40 characters or less.
'
type: string
country:
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.
'
type: string
county:
description: 'County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax.
'
type: string
fax:
description: 'Fax phone number, 40 characters or less.
'
type: string
firstName:
description: 'First name, 100 characters or less.
'
type: string
homePhone:
description: 'Home phone number, 40 characters or less.
'
type: string
lastName:
description: 'Last name, 100 characters or less.
'
type: string
mobilePhone:
description: 'Mobile phone number, 40 characters or less.
'
type: string
nickname:
description: 'Nickname for this contact
'
type: string
otherPhone:
description: 'Other phone number, 40 characters or less.
'
type: string
otherPhoneType:
description: 'Possible values are: `Work`, `Mobile`, `Home`, `Other`.
'
type: string
personalEmail:
description: 'Personal email address, 80 characters or less.
'
type: string
state:
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.
'
type: string
taxRegion:
description: 'If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.
'
type: string
workEmail:
description: 'Work email address, 80 characters or less.
'
type: string
workPhone:
description: 'Work phone number, 40 characters or less.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
required:
- firstName
- lastName
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
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.
'
title: Contact
GETPaymentMethodResponseCreditCardForAccount:
properties:
cardNumber:
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"
type: string
expirationMonth:
description: 'One or two digits expiration month (1-12).
'
type: integer
expirationYear:
description: 'Four-digit expiration year.
'
type: integer
securityCode:
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"
type: string
type: object
GETAccountSummarySubscriptionType:
allOf:
- properties:
autoRenew:
description: 'If `true`, auto-renew is enabled. If `false`, auto-renew is disabled.
'
type: boolean
id:
description: 'Subscription ID.
'
type: string
initialTerm:
description: "Duration of the initial subscription term in whole months. \n"
type: string
ratePlans:
description: 'Container for rate plans for this subscription.
'
items:
$ref: '#/definitions/GETAccountSummarySubscriptionRatePlanType'
type: array
renewalTerm:
description: 'Duration of the renewal term in whole months.
'
type: string
status:
description: 'Subscription status; possible values are: `Draft`, `PendingActivation`, `PendingAcceptance`, `Active`, `Cancelled`, `Expired`.
'
type: string
subscriptionNumber:
description: 'Subscription Number.
'
type: string
subscriptionStartDate:
description: 'Subscription start date.
'
format: date
type: string
termEndDate:
description: 'End date of the subscription term. If the subscription is evergreen, this is either null or equal to the cancellation date, as appropriate.
'
format: date
type: string
termStartDate:
description: 'Start date of the subscription term. If this is a renewal subscription, this date is different than the subscription start date.
'
format: date
type: string
termType:
description: 'Possible values are: `TERMED`, `EVERGREEN`.
'
type: string
type: object
- $ref: '#/definitions/SubscriptionObjectQTFields'
- $ref: '#/definitions/SubscriptionObjectNSFields'
- $ref: '#/definitions/SubscriptionObjectCustomFields'
title: subscriptions
PaymentMethodObjectCustomFields:
additionalProperties:
description: 'Custom fields of the payment method. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of a payment method object.
'
title: paymentMethodFieldsCustom
type: object
GETAccountSummaryPaymentInvoiceType:
properties:
appliedPaymentAmount:
description: 'Amount of payment applied to the invoice.
'
format: decimal
type: string
invoiceId:
description: 'Invoice ID.
'
type: string
invoiceNumber:
description: 'Invoice number.
'
type: string
title: paidInvoices
type: object
GETAccountPaymentMethodType:
allOf:
- properties:
defaultPaymentMethodId:
description: 'ID of the default payment method for the account.
'
type: string
paymentGateway:
description: 'The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.
'
type: string
returnedPaymentMethodType:
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.
**Note:** The response could return more than one payment method type arrays. See **Response samples** as an example.
'
items:
$ref: '#/definitions/GETPaymentMethodResponseForAccount'
title: Payment Method Type
type: array
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
type: object
- $ref: '#/definitions/customAccountPaymentMethod'
GETAccountType:
properties:
basicInfo:
$ref: '#/definitions/GETAccountTypeBasicInfo'
billToContact:
$ref: '#/definitions/GETAccountTypeBillToContact'
billingAndPayment:
description: Container for billing and payment information for the account.
properties:
additionalEmailAddresses:
description: 'A list of additional email addresses to receive email notifications.
'
items:
type: string
type: array
autoPay:
description: 'Whether future payments are automatically collected when they are due during a payment run.
'
type: boolean
billCycleDay:
description: 'Billing cycle day (BCD), the day of the month when a bill run generates invoices for the account.
'
type: string
currency:
description: 'A currency defined in the web-based UI administrative settings.
'
type: string
defaultPaymentMethodId:
description: 'ID of the default payment method for the account.
'
type: string
invoiceDeliveryPrefsEmail:
description: "Whether the customer wants to receive invoices through email. \n"
type: boolean
invoiceDeliveryPrefsPrint:
description: 'Whether the customer wants to receive printed invoices, such as through postal mail.
'
type: boolean
paymentGateway:
description: 'The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.
'
type: string
paymentTerm:
description: 'A payment-terms indicator defined in the web-based UI administrative settings, e.g., "Net 30".
'
type: string
type: object
einvoiceProfile:
$ref: '#/definitions/GetAccountEInvoiceProfile'
metrics:
description: "Container for account metrics of the account's default currency. \n\nIf you have the Multiple Currencies feature in the **Early Adopter** phase enabled, the `metricsData` field provides account metrics of different currencies.\n"
properties:
balance:
description: 'The customer''s total invoice balance minus credit balance.
'
format: decimal
type: string
contractedMrr:
description: 'Future expected MRR that accounts for future upgrades, downgrades, upsells and cancellations.
'
format: decimal
type: string
creditBalance:
description: 'Current credit balance.
'
format: decimal
type: string
reservedPaymentAmount:
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"
format: float
type: number
totalDebitMemoBalance:
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.
Total balance of all posted debit memos.
'
format: decimal
type: string
totalInvoiceBalance:
description: 'Total balance of all posted invoices.
'
format: decimal
type: string
unappliedCreditMemoAmount:
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.
Total unapplied amount of all posted credit memos.
'
format: decimal
type: string
unappliedPaymentAmount:
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.
Total unapplied amount of all posted payments.
'
format: decimal
type: string
type: object
metricsData:
description: 'Container for account metrics of different currencies.
**Note**: This field is available only if you have the Multiple Currencies feature in the **Early Adopter** phase enabled.
'
items:
$ref: '#/definitions/GETAccountCurrencyMetricsType'
type: array
soldToContact:
$ref: '#/definitions/GETAccountTypeSoldToContact'
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
taxInfo:
description: 'Container for tax exempt information, used to establish the tax exempt status of a customer account.
'
properties:
VATId:
description: 'EU Value Added Tax ID.
'
type: string
companyCode:
description: 'Unique code that identifies a company account in Avalara.
'
type: string
exemptCertificateId:
description: 'ID of the customer tax exemption certificate.
'
type: string
exemptCertificateType:
description: 'Type of tax exemption certificate that the customer holds.
'
type: string
exemptDescription:
description: 'Description of the tax exemption certificate that the customer holds.
'
type: string
exemptEffectiveDate:
description: 'Date when the customer tax exemption starts.
'
format: date
type: string
exemptEntityUseCode:
description: 'A unique entity use code to apply exemptions in Avalara AvaTax.
This 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.
'
maxLength: 64
type: string
exemptExpirationDate:
description: 'Date when the customer tax exemption expires.
'
format: date
type: string
exemptIssuingJurisdiction:
description: 'Jurisdiction in which the customer tax exemption certificate was issued.
'
type: string
exemptStatus:
description: 'Status of the account tax exemption.
'
type: string
type: object
type: object
PostAccountEInvoiceProfile:
allOf:
- properties:
businessName:
description: 'The full official name that the Buyer is registered with the relevant legal authority.
'
maxLength: 255
type: string
businessNumber:
description: 'The unique identifier number of the legal entity or person that you do business with.
For example, you must use a GSTIN for India.
'
type: string
businessNumberSchemeId:
description: 'The identification scheme identifier that an official registrar issues to identify the Buyer as a legal entity or person.
'
type: string
enabled:
description: 'Whether to enable the e-invoicing profile for the customer account.
If 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:
- The account must be configured to generate e-invoice files for billing documents.
- The billing document must be in Posted status.
- A business region must be created for the billing country contact, and be linked to an e-invoicing service provider.
'
type: boolean
endpointId:
description: 'The Buyer''s electronic address, to which the application-level response to the billing document might be delivered.
'
type: string
endpointSchemeId:
description: 'The identification scheme identifier of the Buyer’s electronic address.
'
type: string
taxRegisterNumber:
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.
'
type: string
type: object
description: 'Container for e-invoicing profile information for this account.
**Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.
'
title: einvoiceProfile
CreatePaymentMethodBankTransfer:
properties:
IBAN:
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: string
accountHolderInfo:
description: "This container field is required for the following bank transfer payment methods. The nested `accountHolderName` field is required.\n - Direct Debit NZ (`Becsnz`)\n - Single Euro Payments Area (`SEPA`)\n - Direct Debit UK (`Bacs`)\n - Denmark Direct Debit (`Betalingsservice`)\n - Sweden Direct Debit (`Autogiro`)\n - Canadian Pre-Authorized Debit (`PAD`)\n"
properties:
accountHolderName:
description: 'Required.
The full name of the bank account holder.
'
maxLength: 60
type: string
addressLine1:
description: 'The first line of the address for the account holder.
This 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).
'
type: string
addressLine2:
description: "The second line of the address for the account holder. \n"
type: string
city:
description: 'The city where the account holder stays.
It 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.
'
type: string
country:
description: 'The country where the account holder stays.
This 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).
'
type: string
email:
description: 'The email address of the account holder.
'
type: string
firstName:
description: 'The first name of the account holder.
'
type: string
lastName:
description: 'The last name of the account holder.
'
type: string
phone:
description: 'The phone number of the account holder.
'
type: string
state:
description: 'The state where the account holder stays.
'
type: string
zipCode:
description: 'The zip code for the address of the account holder.
'
type: string
type: object
accountMaskNumber:
description: "The masked account number such as ****1234.\n\nWhen creating the following tokenized payment methods, if the `tokens` field is provided, this `accountMaskNumber` field is required.\n - SEPA payment methods on Adyen\n - BACS payment methods on Stripe\n\nFor more information about how to create the preceding tokenized payment methods, see the following articles in Zuora Knowledge Center:\n - Tokenize SEPA payment methods on Adyen Integration v2.0\n - Overview of Stripe payment gateway integration\n"
type: string
accountNumber:
description: "The number of the customer's bank account. This field is required for the following bank transfer payment methods:\n - Direct Entry AU (`Becs`)\n - Direct Debit NZ (`Becsnz`)\n - Direct Debit UK (`Bacs`). For creating tokenized BACS payment methods on Stripe v2, this field is optional. If the `tokens` field is specified, `accountNumber` is not required but `accountMaskNumber` is required.\n - Denmark Direct Debit (`Betalingsservice`)\n - Sweden Direct Debit (`Autogiro`)\n - Canadian Pre-Authorized Debit (`PAD`)\n"
type: string
bankCode:
description: "The sort code or number that identifies the bank. This is also known as the sort code. This field is required for the following bank transfer payment methods:\n - Direct Debit UK (`Bacs`)\n - Denmark Direct Debit (`Betalingsservice`)\n - Direct Debit NZ (`Becsnz`)\n - Canadian Pre-Authorized Debit (`PAD`)\n"
type: string
branchCode:
description: "The branch code of the bank used for direct debit. This field is required for the following bank transfer payment methods:\n - Sweden Direct Debit (`Autogiro`)\n - Direct Entry AU (`Becs`)\n - Direct Debit NZ (`Becsnz`)\n - Canadian Pre-Authorized Debit (`PAD`)\n"
type: string
businessIdentificationCode:
description: 'The BIC code used for SEPA.
'
type: string
currencyCode:
description: 'The currency used for payment method authorization.
If this field is not specified, `currency` specified for the account is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used.
'
type: string
identityNumber:
description: "The identity number used for Bank Transfer. This field is required for the following bank transfer payment methods:\n - Denmark Direct Debit (`Betalingsservice`)\n - Sweden Direct Debit (`Autogiro`)\n"
type: string
tokenize:
default: false
description: "When creating a SEPA payment method on Adyen Integration v2.0, use this field to specify whether to tokenize the payment method with IBAN. If `tokenize` is `true`, `IBAN` is required.\n\nIf the `tokens` field is provided, this `tokenize` field is not required. \n\nFor more information about how to create tokenized SEPA payment methods on Adyen, see Tokenize SEPA payment methods on Adyen Integration v2.0.\n"
type: boolean
tokens:
description: "To create the following tokenized payment methods, pass in the existing token information:\n - Tokenized SEPA payment methods on Adyen Integration v2.0\n - Tokenized BACS payment methods on Stripe v2\n\nFor more information about how to create the preceding tokenized payment methods, see the following articles in Zuora Knowledge Center:\n - Tokenize SEPA payment methods on Adyen Integration v2.0\n - Overview of Stripe payment gateway integration\n"
properties:
gatewayType:
description: "Required. \n\nThe type of the payment gateway to generate the tokens. This field is case-sensitive.\n"
enum:
- Adyen
- Stripe
type: string
secondTokenId:
description: "Pass in the second token of the payment method. The value of this field varies depending on gateways. For more information, see the following articles in Zuora Knowledge Center:\n - Tokenize SEPA payment methods on Adyen Integration v2.0\n - Overview of Stripe payment gateway integration\n"
type: string
thirdTokenId:
description: 'Pass in the third token of the payment method.
'
type: string
tokenId:
description: "Required. \n\nPass in the first token of the payment method. The value of this field varies depending on gateways. For more information, see the following articles in Zuora Knowledge Center:\n - Tokenize SEPA payment methods on Adyen Integration v2.0\n - Overview of Stripe payment gateway integration\n"
type: string
type: object
type: object
CreatePaymentMethodCommon:
properties:
accountKey:
description: 'Internal ID of the customer account that will own the payment method.
'
type: string
authGateway:
description: 'Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method.
If you do not set this field, Zuora will use one of the following payment gateways instead:
* The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set.
* The default payment gateway of your Zuora tenant, if the `accountKey` field is not set.
'
type: string
ipAddress:
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"
type: string
makeDefault:
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.
'
type: boolean
type: object
CreatePaymentMethodApplePayAdyen:
properties:
applePaymentData:
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).
'
type: string
type: object
POSTTierType:
properties:
endingUnit:
description: 'End number of a range of units for the tier.
'
type: number
price:
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.
'
type: number
priceFormat:
description: 'Indicates if pricing is a flat fee or is per unit.
Values:
* `FlatFee`
* `PerUnit`
'
type: string
startingUnit:
description: 'Starting number of a range of units for the tier.
'
type: number
tier:
description: 'Unique number that identifies the tier that the price applies to.
'
format: int64
type: integer
required:
- tier
- price
title: tiers
type: object
PUTAccountType:
allOf:
- properties:
additionalEmailAddresses:
description: 'A list of additional email addresses to receive email notifications. Use commas to separate email addresses.
'
items:
type: string
type: array
autoPay:
description: "Whether future payments are to be automatically billed when they are due. \n"
type: boolean
batch:
description: 'The alias name given to a batch. A string of 50 characters or
less.
**Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package.
'
type: string
billCycleDay:
description: 'Sets the bill cycle day (BCD) for the charge. The BCD determines
which day of the month the customer is billed. Values: Any activated system-defined bill cycle day （`1`-`31`）
'
maxLength: 2
type: integer
billToContact:
$ref: '#/definitions/PUTAccountTypeBillToContact'
communicationProfileId:
description: 'The ID of the communication profile that this account is linked to.
You can provide either or both of the `communicationProfileId` and `profileNumber` fields.
If both are provided, the request will fail if they do not refer to the same communication profile.
'
type: string
creditMemoTemplateId:
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.
The unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.
'
type: string
crmId:
description: 'CRM account ID for the account, up to 100 characters.
'
type: string
customerServiceRepName:
description: 'Name of the account’s customer service representative, if applicable.
'
maxLength: 50
type: string
debitMemoTemplateId:
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.
The unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.
'
type: string
defaultPaymentMethodId:
description: 'ID of the default payment method for the account.
Values: a valid ID for an existing payment method.
'
maxLength: 64
type: string
einvoiceProfile:
$ref: '#/definitions/PUTAccountEinvoiceProfile'
invoiceDeliveryPrefsEmail:
description: "Whether the customer wants to receive invoices through email. \n\nThe default value is `false`.\n"
type: boolean
invoiceDeliveryPrefsPrint:
description: 'Whether the customer wants to receive printed invoices, such as through postal mail.
The default value is `false`.
'
type: boolean
invoiceTemplateId:
description: 'Invoice template ID, configured in Billing Settings in the Zuora UI.
'
type: string
name:
description: 'Account name, up to 255 characters.
'
type: string
notes:
description: 'A string of up to 65,535 characters.
'
type: string
parentId:
description: Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have Customer Hierarchy enabled.
type: string
partnerAccount:
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 Reseller Account feature enabled.\n"
type: boolean
paymentGateway:
description: 'The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.
'
type: string
paymentTerm:
description: Payment terms for this account. Possible values are `Due Upon Receipt`, `Net 30`, `Net 60`, `Net 90`.
type: string
profileNumber:
description: 'The number of the communication profile that this account is linked to.
You can provide either or both of the `communicationProfileId` and `profileNumber` fields.
If both are provided, the request will fail if they do not refer to the same communication profile.
'
type: string
purchaseOrderNumber:
description: The purchase order number provided by your customer for services, products, or both purchased.
type: string
salesRep:
description: The name of the sales representative associated with this account, if applicable. Maximum of 50 characters.
type: string
sequenceSetId:
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"
type: string
soldToContact:
$ref: '#/definitions/PUTAccountTypeSoldToContact'
tagging:
description: ''
type: string
taxInfo:
description: 'Container for tax exempt information, used to establish the tax exempt status of a customer account.
'
properties:
VATId:
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"
type: string
companyCode:
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"
type: string
exemptCertificateId:
description: 'ID of the customer tax exemption certificate. Requires Zuora Tax.
'
type: string
exemptCertificateType:
description: 'Type of tax exemption certificate that the customer holds. Requires Zuora Tax.
'
type: string
exemptDescription:
description: 'Description of the tax exemption certificate that the customer holds. Requires Zuora Tax.
'
type: string
exemptEffectiveDate:
description: 'Date when the customer tax exemption starts. Requires Zuora Tax.
Format: `yyyy-mm-dd`. Defaults to the current date.
'
format: date
type: string
exemptEntityUseCode:
description: 'A unique entity use code to apply exemptions in Avalara AvaTax.
This 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.
'
maxLength: 64
type: string
exemptExpirationDate:
description: 'Date when the customer tax exemption expires. Requires Zuora Tax.
Format: `yyyy-mm-dd`. Defaults to the current date.
'
format: date
type: string
exemptIssuingJurisdiction:
description: 'Jurisdiction in which the customer tax exemption certificate was issued.
'
type: string
exemptStatus:
description: 'Status of the account tax exemption. Requires Zuora Tax.
Required if you use Zuora Tax. This field is unavailable if Zuora Tax is not used.
Values: `Yes`, `No`(default), `pendingVerification`. Note that the value will be set to `No` if no input.
'
type: string
type: object
type: object
- $ref: '#/definitions/AccountObjectNSFields'
- $ref: '#/definitions/AccountObjectCustomFields'
example:
additionalEmailAddresses:
- contact3@example.com
- contact4@example.com
customerServiceRepName: CSR0001
einvoiceProfile:
businessName: legal business name
businessNumber: 20002039
businessNumberSchemeId: 088
enabled: true
endpointId: 08992
endpointSchemeId: 088
taxRegisterNumber: TAX393999
paymentGateway: TestGateway
purchaseOrderNumber: PO0001
POSTAccountTypeSubscription:
allOf:
- properties:
autoRenew:
description: 'If `true`, auto-renew is enabled. Default is `false`.
'
type: boolean
contractEffectiveDate:
description: 'Effective contract date for this subscription, as `yyyy-mm-dd`.
'
format: date
type: string
customerAcceptanceDate:
description: 'The date on which the services or products within a subscription have been accepted by the customer, as `yyyy-mm-dd`.
Default value is dependent on the value of other fields. See Notes section for more details.
'
format: date
type: string
initialTerm:
description: "Duration of the initial subscription term in whole months. Default is 0. \n"
format: int64
type: integer
invoiceOwnerAccountKey:
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"
type: string
invoiceSeparately:
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"
type: boolean
notes:
description: ''
type: string
renewalTerm:
description: 'Duration of the renewal term in whole months. Default is 0.
'
format: int64
type: integer
serviceActivationDate:
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`.
Default value is dependent on the value of other fields. See Notes section for more details.
'
format: date
type: string
subscribeToRatePlans:
description: 'Container for one or more rate plans for this subscription.
'
items:
$ref: '#/definitions/POSTSrpCreateType'
type: array
subscriptionNumber:
description: 'Subscription Number. The value can be up to 1000 characters.
If you do not specify a subscription number when creating a subscription for the new account, Zuora will generate a subscription number automatically.
If the account is created successfully, the subscription number is returned in the `subscriptionNumber` response field.
'
type: string
termStartDate:
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.
'
format: date
type: string
termType:
description: 'Possible values are: `TERMED`, `EVERGREEN`.
'
type: string
required:
- contractEffectiveDate
- termType
type: object
- $ref: '#/definitions/SubscriptionObjectQTFields'
- $ref: '#/definitions/SubscriptionObjectNSFields'
- $ref: '#/definitions/SubscriptionObjectCustomFields'
description: 'Container for subscription information, used if creating a subscription for the new account at the time of account creation.
'
title: subscription
PaymentMethodObjectCustomFieldsForAccount:
additionalProperties:
description: 'Custom fields of the payment method. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of a payment method object.
'
title: paymentMethodFieldsCustom
type: object
GETAccountTypeBillToContact:
allOf:
- properties:
address1:
description: 'First address line, 255 characters or less.
'
type: string
address2:
description: 'Second address line, 255 characters or less.
'
type: string
city:
description: 'City, 40 characters or less.
'
type: string
country:
description: 'Full country name. This field does not contain the ISO-standard abbreviation of the country name.
'
type: string
county:
description: 'County; 32 characters or less. Zuora Tax uses this information to calculate county taxation. '
type: string
fax:
description: 'Fax phone number, 40 characters or less.
'
type: string
firstName:
description: 'First name, 100 characters or less.
'
type: string
homePhone:
description: 'Home phone number, 40 characters or less.
'
type: string
id:
description: ID of the person to bill for the account, 32 characters or less.
type: string
lastName:
description: 'Last name, 100 characters or less.
'
type: string
mobilePhone:
description: 'Mobile phone number, 40 characters or less.
'
type: string
nickname:
description: 'Nickname for this contact.
'
type: string
otherPhone:
description: 'Other phone number, 40 characters or less.
'
type: string
otherPhoneType:
description: 'Possible values are: `Work`, `Mobile`, `Home`, `Other`.
'
type: string
personalEmail:
description: 'Personal email address, 80 characters or less.
'
type: string
state:
description: 'Full state name. This field does not contain the ISO-standard abbreviation of the state name.
'
type: string
taxRegion:
description: 'A region string, defined in your Zuora tax rules.
'
type: string
workEmail:
description: 'Work email address, 80 characters or less.
'
type: string
workPhone:
description: 'Work phone number, 40 characters or less.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
description: 'Container for bill-to contact information.
'
title: Contact
SubscriptionObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Subscription object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of a Subscription object.
'
title: subscriptionFieldsCustom
type: object
PUTAccountTypeBillToContact:
allOf:
- properties:
address1:
description: 'First address line, 255 characters or less.
'
type: string
address2:
description: 'Second address line, 255 characters or less.
'
type: string
city:
description: 'City, 40 characters or less.
'
type: string
country:
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.
'
type: string
county:
description: 'County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax.
'
type: string
fax:
description: 'Fax phone number, 40 characters or less.
'
type: string
firstName:
description: 'First name, 100 characters or less.
'
type: string
homePhone:
description: 'Home phone number, 40 characters or less.
'
type: string
lastName:
description: 'Last name, 100 characters or less.
'
type: string
mobilePhone:
description: 'Mobile phone number, 40 characters or less.
'
type: string
nickname:
description: 'Nickname for this contact
'
type: string
otherPhone:
description: 'Other phone number, 40 characters or less.
'
type: string
otherPhoneType:
description: 'Possible values are: `Work`, `Mobile`, `Home`, `Other`.
'
type: string
personalEmail:
description: 'Personal email address, 80 characters or less.
'
type: string
state:
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.
'
type: string
taxRegion:
description: 'If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.
'
type: string
workEmail:
description: 'Work email address, 80 characters or less.
'
type: string
workPhone:
description: 'Work phone number, 40 characters or less.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
required:
- firstName
- lastName
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
description: 'Container for bill-to contact information for this account.
'
title: Contact
CreatePaymentMethodGooglePayAdyenChase:
properties:
googlePaymentToken:
description: 'This field is specific for setting up Google Pay for Adyen and Chase 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) and [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).
'
type: string
type: object
GETAccountSummaryTypeBillToContact:
allOf:
- properties:
address1:
description: 'First address line, 255 characters or less.
'
type: string
address2:
description: 'Second address line, 255 characters or less.
'
type: string
city:
description: 'City, 40 characters or less.
'
type: string
country:
description: 'Full country name. This field does not contain the ISO-standard abbreviation of the country name.
'
type: string
county:
description: 'County; 32 characters or less. Zuora Tax uses this information to calculate county taxation. '
type: string
fax:
description: 'Fax phone number, 40 characters or less.
'
type: string
firstName:
description: 'First name, 100 characters or less.
'
type: string
id:
description: 'Contact ID.
'
type: string
lastName:
description: 'Last name, 100 characters or less.
'
type: string
state:
description: 'Full state name. This field does not contain the ISO-standard abbreviation of the state name.
'
type: string
taxRegion:
description: 'A region string, defined in your Zuora tax rules.
'
type: string
workEmail:
description: 'Work email address, 80 characters or less.
'
type: string
workPhone:
description: 'Work phone number, 40 characters or less.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
description: "Container for bill-to contact information.\n\n**Note**: \n - If you have the 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 - 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"
title: Contact
GETAccountSummaryUsageType:
properties:
quantity:
description: 'Number of units used.
'
format: decimal
type: string
startDate:
description: 'The start date of a usage period as `yyyy-mm`. Zuora uses this field value to determine the usage date.
'
format: date
type: string
unitOfMeasure:
description: 'Unit by which consumption is measured, as configured in the Billing Settings section of the web-based UI.
'
type: string
title: usage
type: object
GETAccountSummarySubscriptionRatePlanType:
properties:
productId:
description: 'Product ID.
'
type: string
productName:
description: 'Product name.
'
type: string
productRatePlanId:
description: 'Product Rate Plan ID.
'
type: string
productSku:
description: ''
type: string
ratePlanName:
description: 'Rate plan name.
'
type: string
title: ratePlans
type: object
DeleteAccountResponseType:
properties:
id:
description: 'The ID of the deleted account.
'
type: string
jobId:
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](/api-references/api/operation/GET_OperationJob/) API operation to query job information.\n"
type: string
jobStatus:
description: "The status of the account deletion operation. \n"
enum:
- Pending
type: string
reasons:
items:
properties:
code:
description: 'The error code of the response.
'
type: string
message:
description: 'The detail information of the error response.
'
type: string
type: object
type: array
success:
description: 'Whether the call succeeded.
'
type: boolean
type: object
GETPaymentMethodResponseForAccount:
allOf:
- properties:
accountHolderInfo:
$ref: '#/definitions/GETAccountPMAccountHolderInfo'
bankIdentificationNumber:
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.
'
type: string
createdBy:
description: ID of the user who created this payment method.
type: string
createdOn:
description: 'The date and time when the payment method was created, in `yyyy-mm-dd hh:mm:ss` format.
'
format: date-time
type: string
creditCardMaskNumber:
description: 'The masked credit card number, such as:
```
*********1112
```
**Note:** This field is only returned for Credit Card Reference Transaction payment type.
'
type: string
creditCardType:
description: 'The type of the credit card or debit card.
Possible 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).
**Note:** This field is only returned for the Credit Card and Debit Card payment types.
'
type: string
deviceSessionId:
description: 'The session ID of the user when the `PaymentMethod` was created or updated.
'
type: string
existingMandate:
description: 'Indicates whether the mandate is an existing mandate.
'
enum:
- 'Yes'
- 'No'
type: string
id:
description: 'The payment method ID.
'
type: string
ipAddress:
description: 'The IP address of the user when the payment method was created or updated.
'
type: string
isDefault:
description: 'Indicates whether this payment method is the default payment method for the account.
'
type: boolean
lastFailedSaleTransactionDate:
description: 'The date of the last failed attempt to collect payment with this payment method.
'
format: date-time
type: string
lastTransaction:
description: ID of the last transaction of this payment method.
type: string
lastTransactionTime:
description: The time when the last transaction of this payment method happened.
format: date-time
type: string
mandateInfo:
$ref: '#/definitions/POSTAccountPMMandateInfo'
maxConsecutivePaymentFailures:
description: 'The number of allowable consecutive failures Zuora attempts with the payment method before stopping.
'
type: integer
numConsecutiveFailures:
description: "The number of consecutive failed payments for this payment method. It is reset to `0` upon successful payment. \n"
format: int32
type: integer
paymentRetryWindow:
description: 'The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours.
'
type: integer
secondTokenId:
description: 'A gateway unique identifier that replaces sensitive payment method data.
**Note:** This field is only returned for the Credit Card Reference Transaction payment type.
'
type: string
status:
description: 'The status of the payment method.
'
enum:
- Active
- Closed
- Scrubbed
type: string
tokenId:
description: 'A gateway unique identifier that replaces sensitive payment method data or represents a gateway''s unique customer profile.
**Note:** This field is only returned for the Credit Card Reference Transaction payment type.
'
type: string
totalNumberOfErrorPayments:
description: 'The number of error payments that used this payment method.
'
format: int32
type: integer
totalNumberOfProcessedPayments:
description: 'The number of successful payments that used this payment method.
'
format: int32
type: integer
type:
description: 'The type of the payment method. For example, `CreditCard`.
'
type: string
updatedBy:
description: ID of the user who made the last update to this payment method.
type: string
updatedOn:
description: 'The last date and time when the payment method was updated, in `yyyy-mm-dd hh:mm:ss` format.
'
format: date-time
type: string
useDefaultRetryRule:
description: 'Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings.
'
type: boolean
type: object
- $ref: '#/definitions/PaymentMethodObjectCustomFieldsForAccount'
- $ref: '#/definitions/GETPaymentMethodResponseBankTransferForAccount'
- $ref: '#/definitions/GETPaymentMethodResponseACHForAccount'
- $ref: '#/definitions/GETPaymentMethodResponseCreditCardForAccount'
- $ref: '#/definitions/GETPaymentMethodResponsePayPalForAccount'
- $ref: '#/definitions/GETPaymentMethodResponseGooglePayForAccount'
- $ref: '#/definitions/GETPaymentMethodResponseApplePayForAccount'
GETPaymentMethodResponsePayPalForAccount:
properties:
BAID:
description: 'ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9.
'
type: string
email:
description: "Email address associated with the PayPal payment method. \n"
type: string
preapprovalKey:
description: "The PayPal preapproval key. \n"
type: string
type: object
GETAccountSummaryTypeBasicInfo:
allOf:
- properties:
accountNumber:
description: 'Account number.
'
type: string
additionalEmailAddresses:
description: 'A list of additional email addresses to receive email notifications.
'
items:
type: string
type: array
autoPay:
description: 'Whether future payments are automatically collected when they are due during a payment run.
'
type: boolean
balance:
description: 'Current outstanding balance.
'
format: decimal
type: string
batch:
description: 'The alias name given to a batch. A string of 50 characters or less.
'
type: string
billCycleDay:
description: 'Billing cycle day (BCD), the day of the month when a bill run generates invoices for the account.
'
type: string
currency:
description: 'A currency as defined in Billing Settings in the Zuora UI.
'
type: string
defaultPaymentMethod:
description: ''
properties:
creditCardExpirationMonth:
description: 'Two-digit numeric card expiration month as `mm`.
'
type: string
creditCardExpirationYear:
description: 'Four-digit card expiration year as `yyyy`.
'
type: string
creditCardNumber:
description: 'Credit card number, 16 characters or less, displayed in masked format (e.g., ************1234).
'
type: string
creditCardType:
description: 'The type of the credit card.
Possible 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).
'
type: string
id:
description: 'ID of the default payment method associated with this account.
'
type: string
paymentMethodType:
description: ''
type: string
type: object
id:
description: 'Account ID.
'
type: string
invoiceDeliveryPrefsEmail:
description: "Whether the customer wants to receive invoices through email. \n"
type: boolean
invoiceDeliveryPrefsPrint:
description: 'Whether the customer wants to receive printed invoices, such as through postal mail.
'
type: boolean
lastInvoiceDate:
description: 'Date of the most recent invoice for the account; null if no invoice has ever been generated.
'
format: date
type: string
lastMetricsUpdate:
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 Reseller Account 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"
format: date-time
type: string
lastPaymentAmount:
description: 'Amount of the most recent payment collected for the account; null if no payment has ever been collected.
'
format: decimal
type: string
lastPaymentDate:
description: 'Date of the most recent payment collected for the account. Null if no payment has ever been collected.
'
format: date
type: string
name:
description: 'Account name.
'
type: string
organizationLabel:
description: 'The organization that this object belongs to.
Note: This field is available only when the Multi-Org feature is enabled.
'
type: string
partnerAccount:
description: "Whether the customer account is a partner, distributor, or reseller. \n\n\n**Note**: This field is available only if you have the Reseller Account feature enabled.\n"
type: boolean
purchaseOrderNumber:
description: The purchase order number provided by your customer for services, products, or both purchased.
type: string
status:
description: 'Account status; possible values are: `Active`, `Draft`, `Canceled`.
'
type: string
tags:
description: ''
type: string
type: object
- $ref: '#/definitions/AccountObjectNSFields'
- $ref: '#/definitions/AccountObjectCustomFields'
description: 'Container for basic information about the account.
'
title: basicInfo
CreatePaymentMethodPayPalAdaptive:
properties:
preapprovalKey:
description: 'The PayPal preapproval key.
'
type: string
type: object
POSTAccountTypeCreditCard:
allOf:
- properties:
cardHolderInfo:
description: 'Container for cardholder information.
'
properties:
addressLine1:
description: 'First address line, 255 characters or less.
'
type: string
addressLine2:
description: 'Second address line, 255 characters or less.
'
type: string
cardHolderName:
description: 'The card holder''s full name as it appears on the card, e.g., "John J Smith", 50 characters or less.
'
type: string
city:
description: 'City, 40 characters or less.
It 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.
'
type: string
country:
description: 'Country; must be a valid country name or abbreviation.
It 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.
'
type: string
email:
description: 'Card holder''s email address, 80 characters or less.
'
type: string
phone:
description: 'Phone number, 40 characters or less.
'
type: string
state:
description: 'State; must be a valid state name or 2-character abbreviation.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
required:
- addressLine1
- cardHolderName
- city
- country
- state
- zipCode
cardNumber:
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).
'
type: string
cardType:
description: 'The type of the credit card.
Possible 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).
'
type: string
expirationMonth:
description: 'Two-digit expiration month (01-12).
'
type: string
expirationYear:
description: 'Four-digit expiration year.
'
type: string
securityCode:
description: 'The CVV or CVV2 security code of the card. To ensure PCI compliance, this value is not stored and cannot be queried.
'
type: string
required:
- cardHolderInfo
- cardNumber
- cardType
- expirationMonth
- expirationYear
type: object
- $ref: '#/definitions/PaymentMethodObjectCustomFields'
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"
title: creditCard
GETAccountTypeSoldToContact:
allOf:
- properties:
address1:
description: 'First address line, 255 characters or less.
'
type: string
address2:
description: 'Second address line, 255 characters or less.
'
type: string
city:
description: 'City, 40 characters or less.
'
type: string
country:
description: 'Full country name. This field does not contain the ISO-standard abbreviation of the country name.
'
type: string
county:
description: 'County; 32 characters or less. Zuora tax uses this information to calculate county taxation. '
type: string
fax:
description: 'Fax phone number, 40 characters or less.
'
type: string
firstName:
description: 'First name, 100 characters or less.
'
type: string
homePhone:
description: 'Home phone number, 40 characters or less.
'
type: string
id:
description: ID of the person who bought the subscription associated with the account, 32 characters or less.
type: string
lastName:
description: 'Last name, 100 characters or less.
'
type: string
mobilePhone:
description: 'Mobile phone number, 40 characters or less.
'
type: string
nickname:
description: 'Nickname for this contact.
'
type: string
otherPhone:
description: 'Other phone number, 40 characters or less.
'
type: string
otherPhoneType:
description: 'Possible values are: `Work`, `Mobile`, `Home`, `Other`.
'
type: string
personalEmail:
description: 'Personal email address, 80 characters or less.
'
type: string
state:
description: 'Full state name. This field does not contain the ISO-standard abbreviation of the state name.
'
type: string
taxRegion:
description: 'A region string, defined in your Zuora tax rules.
'
type: string
workEmail:
description: 'Work email address, 80 characters or less.
'
type: string
workPhone:
description: 'Work phone number, 40 characters or less.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
description: 'Container for sold-to contact information. Uses the same field structure as billToContact.
'
title: Contact
GETPaymentMethodResponseApplePayForAccount:
properties:
appleBIN:
description: 'This field is only available for Apple Pay payment methods.
'
type: string
appleCardNumber:
description: 'This field is only available for Apple Pay payment methods.
'
type: string
appleCardType:
description: 'This field is only available for Apple Pay payment methods.
For 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.
'
type: string
appleExpiryDate:
description: 'This field is only available for Apple Pay payment methods.
'
type: string
appleGatewayToken:
description: 'This field is only available for Apple Pay payment methods.
'
type: string
type: object
GETAccountSummaryType:
properties:
basicInfo:
$ref: '#/definitions/GETAccountSummaryTypeBasicInfo'
billToContact:
$ref: '#/definitions/GETAccountSummaryTypeBillToContact'
invoices:
description: 'Container for invoices. Only returns the last 6 invoices.
'
items:
$ref: '#/definitions/GETAccountSummaryInvoiceType'
type: array
payments:
description: 'Container for payments. Only returns the last 6 payments.
'
items:
$ref: '#/definitions/GETAccountSummaryPaymentType'
type: array
soldToContact:
$ref: '#/definitions/GETAccountSummaryTypeSoldToContact'
subscriptions:
description: 'Container for subscriptions.
'
items:
$ref: '#/definitions/GETAccountSummarySubscriptionType'
type: array
success:
description: 'Returns `true` if the request was processed successfully.
'
type: boolean
taxInfo:
description: 'Container for tax exempt information, used to establish the tax exempt status of a customer account.
'
properties:
VATId:
description: 'EU Value Added Tax ID.
'
type: string
companyCode:
description: 'Unique code that identifies a company account in Avalara.
'
type: string
exemptCertificateId:
description: 'ID of the customer tax exemption certificate.
'
type: string
exemptCertificateType:
description: 'Type of tax exemption certificate that the customer holds.
'
type: string
exemptDescription:
description: 'Description of the tax exemption certificate that the customer holds.
'
type: string
exemptEffectiveDate:
description: 'Date when the customer tax exemption starts.
'
format: date
type: string
exemptEntityUseCode:
description: 'A unique entity use code to apply exemptions in Avalara AvaTax.
This 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.
'
maxLength: 64
type: string
exemptExpirationDate:
description: 'Date when the customer tax exemption expires.
'
format: date
type: string
exemptIssuingJurisdiction:
description: 'Jurisdiction in which the customer tax exemption certificate was issued.
'
type: string
exemptStatus:
description: 'Status of the account tax exemption.
'
type: string
type: object
usage:
description: 'Container for usage data. Only returns the last 6 months of usage.
**Note:** If the Active Rating feature is enabled, no usage data is returned in the response body field.
'
items:
$ref: '#/definitions/GETAccountSummaryUsageType'
type: array
type: object
GETPaymentMethodResponseBankTransferForAccount:
properties:
IBAN:
description: 'The International Bank Account Number used to create the SEPA payment method. The value is masked.
'
type: string
accountNumber:
description: 'The number of the customer''s bank account and it is masked.
'
type: string
bankCode:
description: "The sort code or number that identifies the bank. This is also known as the sort code. \n"
type: string
bankTransferType:
description: 'The type of the Bank Transfer payment method. For example, `SEPA`.
'
type: string
branchCode:
description: 'The branch code of the bank used for Direct Debit.
'
type: string
businessIdentificationCode:
description: "The BIC code used for SEPA. The value is masked. \n"
type: string
identityNumber:
description: "The identity number used for Bank Transfer. \n"
type: string
type: object
PUTAccountTypeSoldToContact:
allOf:
- properties:
address1:
description: 'First address line, 255 characters or less.
'
type: string
address2:
description: 'Second address line, 255 characters or less.
'
type: string
city:
description: 'City, 40 characters or less.
'
type: string
country:
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.
'
type: string
county:
description: 'County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax.
'
type: string
fax:
description: 'Fax phone number, 40 characters or less.
'
type: string
firstName:
description: 'First name, 100 characters or less.
'
type: string
homePhone:
description: 'Home phone number, 40 characters or less.
'
type: string
lastName:
description: 'Last name, 100 characters or less.
'
type: string
mobilePhone:
description: 'Mobile phone number, 40 characters or less.
'
type: string
nickname:
description: 'Nickname for this contact
'
type: string
otherPhone:
description: 'Other phone number, 40 characters or less.
'
type: string
otherPhoneType:
description: 'Possible values are: `Work`, `Mobile`, `Home`, `Other`.
'
type: string
personalEmail:
description: 'Personal email address, 80 characters or less.
'
type: string
state:
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.
'
type: string
taxRegion:
description: 'If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.
'
type: string
workEmail:
description: 'Work email address, 80 characters or less.
'
type: string
workPhone:
description: 'Work phone number, 40 characters or less.
'
type: string
zipCode:
description: 'Zip code, 20 characters or less.
'
type: string
required:
- firstName
- lastName
type: object
- $ref: '#/definitions/ContactObjectCustomFields'
description: 'Container for optional sold-to contact.
'
title: Contact
GETPaymentMethodResponseGooglePayForAccount:
properties:
googleBIN:
description: 'This field is only available for Google Pay payment methods.
'
type: string
googleCardNumber:
description: 'This field is only available for Google Pay payment methods.
'
type: string
googleCardType:
description: 'This field is only available for Google Pay payment methods.
For 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.
'
type: string
googleExpiryDate:
description: 'This field is only available for Google Pay payment methods.
'
type: string
googleGatewayToken:
description: 'This field is only available for Google Pay payment methods.
'
type: string
type: object
GETAccountTypeBasicInfo:
allOf:
- properties:
accountNumber:
description: 'Account number.
'
type: string
batch:
description: 'The alias name given to a batch. A string of 50 characters or less.
'
type: string
communicationProfileId:
description: The ID of the communication profile that this account is linked to.
type: string
creditMemoTemplateId:
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.
The unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.
'
type: string
crmId:
description: 'CRM account ID for the account, up to 100 characters.
'
type: string
debitMemoTemplateId:
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.
The unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.
'
type: string
id:
description: 'Account ID.
'
type: string
invoiceTemplateId:
description: 'Invoice template ID, configured in Billing Settings in the Zuora UI.
'
type: string
lastMetricsUpdate:
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 Reseller Account 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"
format: date-time
type: string
name:
description: 'Account name.
'
type: string
notes:
description: 'Notes associated with the account, up to 65,535 characters.
'
type: string
organizationLabel:
description: 'The organization that this object belongs to.
Note: This field is available only when the Multi-Org feature is enabled.
'
type: string
parentId:
description: Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have Customer Hierarchy enabled.
type: string
partnerAccount:
description: "Whether the customer account is a partner, distributor, or reseller. \n\n\n**Note**: This field is available only if you have the Reseller Account feature enabled.\n"
type: boolean
profileNumber:
description: The number of the communication profile that this account is linked to.
type: string
purchaseOrderNumber:
description: The purchase order number provided by your customer for services, products, or both purchased.
type: string
salesRep:
description: The name of the sales representative associated with this account, if applicable. Maximum of 50 characters.
type: string
sequenceSetId:
description: "The ID of the billing document sequence set that is assigned to the customer account. \n"
type: string
status:
description: 'Account status; possible values are: `Active`, `Draft`, `Canceled`.
'
type: string
tags:
description: ''
type: string
type: object
- $ref: '#/definitions/AccountObjectNSFields'
- $ref: '#/definitions/AccountObjectCustomFields'
description: 'Container for basic information about the account.
'
title: basicInfo
PUTAccountEinvoiceProfile:
allOf:
- properties:
businessName:
description: 'Legal Business Name. The full formal name by which the Buyer is registered with the relevant legal authority. '
maxLength: 255
type: string
businessNumber:
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. '
type: string
businessNumberSchemeId:
description: 'Business Number Schema Id. The identification scheme identifier of the Buyer legal registration identifier. '
type: string
enabled:
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. '
type: boolean
endpointId:
description: 'Buyer electronic address.Identifies the Buyer''s electronic address to which the invoice is delivered.
'
type: string
endpointSchemeId:
description: 'Buyer electronic address identification scheme identifier. '
type: string
taxRegisterNumber:
description: 'Buyer VAT identifier. The Buyer''s VAT identifier (also known as Buyer VAT identification number).
'
type: string
type: object
description: 'Container for profile information for this account.
'
title: einvoiceProfile
RatePlanChargeObjectCustomFields:
additionalProperties:
description: 'Custom fields of the Rate Plan Charge object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.
'
description: 'Container for custom fields of a Rate Plan Charge object.
'
title: ratePlanChargeFieldsCustom
type: object
GETPaymentMethodResponseACHForAccount:
properties:
bankABACode:
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`.
'
type: string
bankAccountName:
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`.
'
type: string
type: object
POSTSrpCreateType:
allOf:
- properties:
chargeOverrides:
description: 'This optional container is used to override the quantity of one or more product rate plan charges for this subscription.
'
items:
$ref: '#/definitions/POSTScCreateType'
type: array
externalCatalogPlanId:
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.
**Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.
'
type: string
externalIdSourceSystem:
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.
**Note:** If both `externalCatalogPlanId`, `externalIdSourceSystem` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.
'
type: string
externallyManagedPlanId:
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.
'
type: string
productRatePlanId:
description: 'ID of a product rate plan for this subscription.
'
type: string
productRatePlanNumber:
description: 'Number of a product rate plan for this subscription.
'
type: string
type: object
- $ref: '#/definitions/RatePlanObjectCustomFields'
title: subscribeToRatePlans
CreatePaymentMethodCCReferenceTransaction:
properties:
creditCardMaskNumber:
description: 'The masked credit card number, such as:
```
*********1112
```
This 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.
Though there are no special restrictions on the input string, it is highly recommended to specify a card number that is masked.
'
maxLength: 19
type: string
secondTokenId:
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"
type: string
tokenId:
description: "A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. `tokenId` is required for the CC Reference Transaction payment method.\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\n**Note:** \n - When creating an ACH payment method, if you need to pass in tokenized information, use the `mandateId` instead of `tokenId` field.\n - When creating the following payment methods, if you need to pass in token information, use the `tokens` > `tokenId` and `tokens` > `secondTokenId` fields instead of this `tokenId` field:\n - SEPA on Adyen Integration v2.0\n - BACS on Stripe v2\n \n"
type: string
type: object
parameters:
GLOBAL_HEADER_Accept_Encoding:
name: Accept-Encoding
in: header
required: false
type: string
description: "Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n"
GLOBAL_HEADER_Zuora_Org_Ids:
name: Zuora-Org-Ids
in: header
required: false
type: string
description: "Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.\n\nIf the header is not set, the operation is performed in scope of the user's accessible orgs.\n"
GLOBAL_HEADER_Idempotency_Key:
name: Idempotency-Key
in: header
required: false
type: string
maxLength: 255
description: "Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"
GLOBAL_HEADER_Content_Encoding:
name: Content-Encoding
in: header
required: false
type: string
description: 'Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
'
GLOBAL_HEADER_Zuora_Entity_Ids_Single:
name: Zuora-Entity-Ids
in: header
required: false
type: string
description: 'An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
'
GLOBAL_HEADER_Zuora_Track_Id:
name: Zuora-Track-Id
in: header
required: false
type: string
maxLength: 64
description: 'A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.
The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`''`).
'
GLOBAL_HEADER_Authorization_OAuth_optional:
name: Authorization
in: header
required: false
type: string
description: 'The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](/api-references/api/operation/createToken).
'
x-tagGroups:
- name: Authentication
tags:
- OAuth
- name: Products
tags:
- Products
- Catalog
- Catalog Groups
- Offers
- Price Book Items
- Product Rate Plans
- Product Rate Plan Definitions
- Product Rate Plan Charges
- Product Charge Definitions
- Product Rate Plan Charge Tiers
- Zuora Revenue Integration
- name: Customer Accounts
tags:
- Accounts
- Contacts
- Contact Snapshots
- name: Orders and Subscriptions
tags:
- Sign Up
- Orders
- Order Actions
- Order Line Items
- Fulfillments
- Ramps
- Subscriptions
- Rate Plans
- name: Advanced Consumption Billing
tags:
- Prepaid with Drawdown
- name: Usage
tags:
- Usage
- name: Billing Documents
tags:
- Delivery Adjustments
- Billing Documents
- Invoices
- Credit Memos
- Debit Memos
- E-Invoicing
- Invoice Schedules
- Taxation Items
- Sequence Sets
- Operations
- name: Bill Runs
tags:
- Bill Run
- Billing Preview Run
- name: Payment Methods
tags:
- Payment Methods
- Custom Payment Method Types
- Payment Method Updater
- Payment Method Snapshots
- Payment Method Transaction Logs
- Hosted Pages
- RSA Signatures
- name: Payments
tags:
- Payment Authorization
- Payment Gateways
- Payment Gateway Reconciliation
- Payments
- Payment Transaction Logs
- Payment Runs
- Payment Schedules
- Refunds
- name: Finance
tags:
- Accounting Codes
- Accounting Periods
- Summary Journal Entries
- Journal Runs
- Mass Updater
- name: Events and Notifications
tags:
- Notifications
- Custom Event Triggers
- Custom Scheduled Events
- name: Custom Objects
tags:
- Custom Object Definitions
- Custom Object Records
- Custom Object Jobs
- name: System Health
tags:
- API Health
- Bill Run Health
- Electronic Payments Health
- name: Workflow
tags:
- Workflows
- name: Data Query
tags:
- Data Queries
- name: AQuA
tags:
- Aggregate Queries
- name: Deployment Manager
tags:
- Configuration Templates
- name: Multiple Organizations
tags:
- Data Labeling
- name: Order to Revenue
tags:
- Regenerate
- name: General-Purpose Operations
tags:
- Actions
- Settings
- Files
- Imports
- Custom Exchange Rates
- Attachments
- Describe