Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Accounts API

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.

Zuora Accounts API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Accounts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 5 paths, and defines 65 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

7 operations 5 paths 65 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Accounts 7

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 [Cr…

POST
/v1/accounts
Create an account
POST_Account 9 params → 200
GET
/v1/accounts/{account-key}
Retrieve an account
GET_Account 7 params → 200
PUT
/v1/accounts/{account-key}
Update an account
PUT_Account 8 params → 200
DELETE
/v1/accounts/{account-key}
Delete an account
DELETE_Account 7 params → 200
GET
/v1/accounts/{account-key}/summary
Retrieve an account summary
GET_AccountSummary 8 params → 200
GET
/v1/accounts/{account-key}/payment-methods
List payment methods of an account
GET_AcountPaymentMethods 9 params → 200
GET
/v1/accounts/{account-key}/payment-methods/default
Retrieve the default payment method of an account
GET_AcountDefaultPaymentMethod 7 params → 200

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are CreatePaymentMethodCreditCard (14 properties), POSTAccountResponseType (14 properties), POSTAccountPMMandateInfo (13 properties), CreatePaymentMethodACH (12 properties). Each schema is shown below with its type and property counts.

GETAccountCurrencyMetricsType
POSTAccountTypeSoldToContact
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 fro…
POSTAccountTypePaymentMethod
Container for information on payment methods to associate with this account. To associate a credit card payment method when creating an account, Zuora recommen…
AccountObjectCustomFields
object
Container for custom fields of an Account object.
GETAccountPMAccountHolderInfo
object
The account holder information.
9 properties
SubscriptionObjectQTFields
object
Container for Subscription fields provided by Zuora Quotes.
6 properties
AccountObjectNSFields
object
Container for Account fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
9 properties
CommonResponseType
object
3 properties
POSTScCreateType
CreatePaymentMethodACH
object
12 properties
customAccountPaymentMethod
object
Container for custom payment methods created through the [Open Payment Method](https://knowledgecenter.zuora.com/Billing/BillingandPayments/MBSetupcustompaymen…
GetAccountEInvoiceProfile
object
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 e…
7 properties
ChargeModelConfigurationType
object
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 Pricin…
3 properties
SubscriptionObjectNSFields
object
Container for Subscription fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
5 properties
GETAccountSummaryTypeSoldToContact
Container for sold-to contact information. Note: - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body…
ContactObjectCustomFields
object
Container for custom fields of a Contact object.
POSTAccountPMMandateInfo
object
The mandate information for the Credit Card, Apple Pay, Google Pay, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. The following mand…
13 properties
GETAccountSummaryPaymentType
object
6 properties
GETAccountSummaryInvoiceType
object
7 properties
POSTAccountType
CreatePaymentMethodCreditCard
object
14 properties
CreatePaymentMethodCardholderInfo
object
Container for cardholder information. This container field is required for credit card payment methods. The nested cardHolderName field is required.
9 properties 1 required
CreatePMPayPalECPayPalNativeECPayPalCP
object
2 properties
RatePlanObjectCustomFields
object
Container for custom fields of a Rate Plan object.
POSTAccountResponseType
object
14 properties
POSTAccountTypeBillToContact
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…
GETPaymentMethodResponseCreditCardForAccount
object
4 properties
GETAccountSummarySubscriptionType
PaymentMethodObjectCustomFields
object
Container for custom fields of a payment method object.
GETAccountSummaryPaymentInvoiceType
object
3 properties
GETAccountPaymentMethodType
GETAccountType
object
9 properties
PostAccountEInvoiceProfile
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 e…
CreatePaymentMethodBankTransfer
object
11 properties
CreatePaymentMethodCommon
object
4 properties
CreatePaymentMethodApplePayAdyen
object
1 property
POSTTierType
object
5 properties 2 required
PUTAccountType
POSTAccountTypeSubscription
Container for subscription information, used if creating a subscription for the new account at the time of account creation.
PaymentMethodObjectCustomFieldsForAccount
object
Container for custom fields of a payment method object.
GETAccountTypeBillToContact
Container for bill-to contact information.
SubscriptionObjectCustomFields
object
Container for custom fields of a Subscription object.
PUTAccountTypeBillToContact
Container for bill-to contact information for this account.
CreatePaymentMethodGooglePayAdyenChase
object
1 property
GETAccountSummaryTypeBillToContact
Container for bill-to contact information. Note: - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body…
GETAccountSummaryUsageType
object
3 properties
GETAccountSummarySubscriptionRatePlanType
object
5 properties
DeleteAccountResponseType
object
5 properties
GETPaymentMethodResponseForAccount
GETPaymentMethodResponsePayPalForAccount
object
3 properties
GETAccountSummaryTypeBasicInfo
Container for basic information about the account.
CreatePaymentMethodPayPalAdaptive
object
1 property
POSTAccountTypeCreditCard
Note: This field has been deprecated, and is currently available only for backward compatibility. Use the paymentMethod field instead to create a payment metho…
GETAccountTypeSoldToContact
Container for sold-to contact information. Uses the same field structure as billToContact.
GETPaymentMethodResponseApplePayForAccount
object
5 properties
GETAccountSummaryType
object
9 properties
GETPaymentMethodResponseBankTransferForAccount
object
7 properties
PUTAccountTypeSoldToContact
Container for optional sold-to contact.
GETPaymentMethodResponseGooglePayForAccount
object
5 properties
GETAccountTypeBasicInfo
Container for basic information about the account.
PUTAccountEinvoiceProfile
Container for profile information for this account.
RatePlanChargeObjectCustomFields
object
Container for custom fields of a Rate Plan Charge object.
GETPaymentMethodResponseACHForAccount
object
2 properties
POSTSrpCreateType
CreatePaymentMethodCCReferenceTransaction
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-accounts-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API
Zuora Catalog API