All URIs are relative to https://rest.zuora.com
| Method | HTTP request | Description |
|---|---|---|
| g_et_account | GET /v1/accounts/{account-key} | Get account |
| g_et_account_summary | GET /v1/accounts/{account-key}/summary | Get account summary |
| g_et_billing_document_files_deletion_job | GET /v1/accounts/billing-documents/files/deletion-jobs/{jobId} | Get job of hard deleting billing document files |
| object_delete_account | DELETE /v1/object/account/{id} | CRUD: Delete Account |
| object_get_account | GET /v1/object/account/{id} | CRUD: Retrieve Account |
| object_post_account | POST /v1/object/account | CRUD: Create Account |
| object_put_account | PUT /v1/object/account/{id} | CRUD: Update Account |
| p_ost_account | POST /v1/accounts | Create account |
| p_ost_billing_document_files_deletion_job | POST /v1/accounts/billing-documents/files/deletion-jobs | Create job to hard delete billing document files |
| p_ost_generate_billing_documents | POST /v1/accounts/{id}/billing-documents/generate | Generate billing documents by account |
| p_ut_account | PUT /v1/accounts/{account-key} | Update account |
GETAccountType g_et_account(account_key, zuora_entity_ids=zuora_entity_ids)
Get account
This REST API reference describes how to retrieve basic information about a customer account. This REST call 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.
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.AccountsApi()
account_key = 'account_key_example' # str | Account number or account ID.
zuora_entity_ids = 'zuora_entity_ids_example' # str | 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. (optional)
try:
# Get account
api_response = api_instance.g_et_account(account_key, zuora_entity_ids=zuora_entity_ids)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->g_et_account: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| account_key | str | Account number or account ID. | |
| zuora_entity_ids | str | An entity ID. If you have Zuora 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. | [optional] |
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GETAccountSummaryType g_et_account_summary(account_key, zuora_entity_ids=zuora_entity_ids)
Get account summary
This REST API reference describes how to retrieve detailed information about the specified customer account. The response includes the account information and a summary of the account’s subscriptions, invoices, payments, and usages for the last six recently updated subscriptions. ## Notes Returns 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.
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.AccountsApi()
account_key = 'account_key_example' # str | Account number or account ID.
zuora_entity_ids = 'zuora_entity_ids_example' # str | 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. (optional)
try:
# Get account summary
api_response = api_instance.g_et_account_summary(account_key, zuora_entity_ids=zuora_entity_ids)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->g_et_account_summary: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| account_key | str | Account number or account ID. | |
| zuora_entity_ids | str | An entity ID. If you have Zuora 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. | [optional] |
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GETBillingDocumentFilesDeletionJobResponse g_et_billing_document_files_deletion_job(job_id, zuora_entity_ids=zuora_entity_ids)
Get job of hard deleting billing document files
Retrieves information about an asynchronous job of permanently deleting all billing document PDF files for specific accounts. Note: This REST API operation can be used only if you have the Billing user permission "Hard Delete Billing Document Files" enabled.
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.AccountsApi()
job_id = 'job_id_example' # str | The unique ID of a billing document file deletion job. For example, 2c92c8f83dc4f752013dc72c24ee016c.
zuora_entity_ids = 'zuora_entity_ids_example' # str | 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. (optional)
try:
# Get job of hard deleting billing document files
api_response = api_instance.g_et_billing_document_files_deletion_job(job_id, zuora_entity_ids=zuora_entity_ids)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->g_et_billing_document_files_deletion_job: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| job_id | str | The unique ID of a billing document file deletion job. For example, 2c92c8f83dc4f752013dc72c24ee016c. | |
| zuora_entity_ids | str | An entity ID. If you have Zuora 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. | [optional] |
GETBillingDocumentFilesDeletionJobResponse
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProxyDeleteResponse object_delete_account(id, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
CRUD: Delete Account
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.AccountsApi()
id = 'id_example' # str | Object id
zuora_entity_ids = 'zuora_entity_ids_example' # str | 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. (optional)
zuora_track_id = 'zuora_track_id_example' # str | 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 (`'`). (optional)
try:
# CRUD: Delete Account
api_response = api_instance.object_delete_account(id, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->object_delete_account: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | Object id | |
| zuora_entity_ids | str | An entity ID. If you have Zuora 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. | [optional] |
| zuora_track_id | str | 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 (`'`). | [optional] |
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProxyGetAccount object_get_account(id, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id, fields=fields)
CRUD: Retrieve Account
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.AccountsApi()
id = 'id_example' # str | Object id
zuora_entity_ids = 'zuora_entity_ids_example' # str | 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. (optional)
zuora_track_id = 'zuora_track_id_example' # str | 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 (`'`). (optional)
fields = 'fields_example' # str | Object fields to return (optional)
try:
# CRUD: Retrieve Account
api_response = api_instance.object_get_account(id, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id, fields=fields)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->object_get_account: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | Object id | |
| zuora_entity_ids | str | An entity ID. If you have Zuora 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. | [optional] |
| zuora_track_id | str | 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 (`'`). | [optional] |
| fields | str | Object fields to return | [optional] |
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProxyCreateOrModifyResponse object_post_account(create_request, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
CRUD: Create Account
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.AccountsApi()
create_request = zuora_client.ProxyCreateAccount() # ProxyCreateAccount |
zuora_entity_ids = 'zuora_entity_ids_example' # str | 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. (optional)
zuora_track_id = 'zuora_track_id_example' # str | 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 (`'`). (optional)
try:
# CRUD: Create Account
api_response = api_instance.object_post_account(create_request, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->object_post_account: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| create_request | ProxyCreateAccount | ||
| zuora_entity_ids | str | An entity ID. If you have Zuora 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. | [optional] |
| zuora_track_id | str | 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 (`'`). | [optional] |
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProxyCreateOrModifyResponse object_put_account(id, modify_request, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
CRUD: Update Account
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.AccountsApi()
id = 'id_example' # str | Object id
modify_request = zuora_client.ProxyModifyAccount() # ProxyModifyAccount |
zuora_entity_ids = 'zuora_entity_ids_example' # str | 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. (optional)
zuora_track_id = 'zuora_track_id_example' # str | 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 (`'`). (optional)
try:
# CRUD: Update Account
api_response = api_instance.object_put_account(id, modify_request, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->object_put_account: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | Object id | |
| modify_request | ProxyModifyAccount | ||
| zuora_entity_ids | str | An entity ID. If you have Zuora 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. | [optional] |
| zuora_track_id | str | 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 (`'`). | [optional] |
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
POSTAccountResponseType p_ost_account(request, zuora_entity_ids=zuora_entity_ids, zuora_version=zuora_version)
Create account
This REST API reference describes how to create a customer account with a credit-card payment method, a bill-to contact, and an optional sold-to contact. Request and response field descriptions and sample code are provided. Use this method 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. This API call is CORS Enabled, so you can use client-side Javascript to invoke the call. ## Notes 1. The account is created in active status. 2. The request must provide either a creditCard structure or the hpmCreditCardPaymentMethodId field (but not both). The one provided becomes the default payment method for this account. If the credit card information is declined or can't be verified, then the account is not created. 3. Customer accounts created with this call are automatically be set to Auto Pay. 4. If either the workEmail or personalEmail are specified, then the account's email delivery preference is automatically set to true. (In that case, emails go to the workEmail address, if it exists, or else the personalEmail.) If neither field is specified, the email delivery preference is automatically set to false. 5. You cannot use this operation to create subscriptions if you have the Orders feature enabled. See Orders Migration Guidance for more information. ## Defaults for customerAcceptanceDate and serviceActivationDate Default values for customerAcceptanceDate and serviceActivationDate are set as follows. | | serviceActivationDate(SA) specified | serviceActivationDate (SA) NOT specified | | ------------- |:-------------:| -----:| | 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 | | customerAcceptanceDate (CA) NOT specified | SA uses value in the request call; CA uses SA as default | SA and CA use CE as default |
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.AccountsApi()
request = zuora_client.POSTAccountType() # POSTAccountType |
zuora_entity_ids = 'zuora_entity_ids_example' # str | 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. (optional)
zuora_version = 'zuora_version_example' # str | The minor version of the Zuora REST API. You only need to set this parameter if you use the following fields: * invoice * collect * runBilling * targetDate (optional)
try:
# Create account
api_response = api_instance.p_ost_account(request, zuora_entity_ids=zuora_entity_ids, zuora_version=zuora_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->p_ost_account: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| request | POSTAccountType | ||
| zuora_entity_ids | str | An entity ID. If you have Zuora 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. | [optional] |
| zuora_version | str | The minor version of the Zuora REST API. You only need to set this parameter if you use the following fields: * invoice * collect * runBilling * targetDate | [optional] |
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
POSTBillingDocumentFilesDeletionJobResponse p_ost_billing_document_files_deletion_job(body, zuora_entity_ids=zuora_entity_ids)
Create job to hard delete billing document files
Creates an asynchronous job to permanently delete all billing document PDF files for specific accounts. After the deletion job is completed, all billing document PDF files are permanently deleted. To retrieve the status of a deletion job, call Get job of hard deleting billing document files. Note: This REST API operation can be used only if you have the Billing user permission "Hard Delete Billing Document Files" enabled.
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.AccountsApi()
body = zuora_client.POSTBillingDocumentFilesDeletionJobRequest() # POSTBillingDocumentFilesDeletionJobRequest |
zuora_entity_ids = 'zuora_entity_ids_example' # str | 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. (optional)
try:
# Create job to hard delete billing document files
api_response = api_instance.p_ost_billing_document_files_deletion_job(body, zuora_entity_ids=zuora_entity_ids)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->p_ost_billing_document_files_deletion_job: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| body | POSTBillingDocumentFilesDeletionJobRequest | ||
| zuora_entity_ids | str | An entity ID. If you have Zuora 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. | [optional] |
POSTBillingDocumentFilesDeletionJobResponse
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GenerateBillingDocumentResponseType p_ost_generate_billing_documents(body, id, zuora_entity_ids=zuora_entity_ids)
Generate billing documents by account
Generates draft or posted billing documents for a specified account. You can also generate billing documents for specified subscriptions of a specified account. The billing documents contain invoices and credit memos. To generate credit memos, you must have the Invoice Settlement feature enabled.
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.AccountsApi()
body = zuora_client.PostGenerateBillingDocumentType() # PostGenerateBillingDocumentType |
id = 'id_example' # str | The ID of the customer account that billing documents are generated for. For example, 8a8082e65b27f6c3015ba3e326b26419.
zuora_entity_ids = 'zuora_entity_ids_example' # str | 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. (optional)
try:
# Generate billing documents by account
api_response = api_instance.p_ost_generate_billing_documents(body, id, zuora_entity_ids=zuora_entity_ids)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->p_ost_generate_billing_documents: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| body | PostGenerateBillingDocumentType | ||
| id | str | The ID of the customer account that billing documents are generated for. For example, 8a8082e65b27f6c3015ba3e326b26419. | |
| zuora_entity_ids | str | An entity ID. If you have Zuora 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. | [optional] |
GenerateBillingDocumentResponseType
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CommonResponseType p_ut_account(account_key, request, zuora_entity_ids=zuora_entity_ids)
Update account
This REST API reference describes how to update a customer account by specifying the account-key. ## Notes 1. Only the fields to be changed should be specified. Any field that's not included in the request body will not be changed. 2. If an empty field is submitted with this call, 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 on file or to the email delivery preference. If either the personalEmail or workEmail is specified (or both), the system updates the corresponding email address(es) on file 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; updating either one does not update the other.
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.AccountsApi()
account_key = 'account_key_example' # str | Account number or account ID.
request = zuora_client.PUTAccountType() # PUTAccountType |
zuora_entity_ids = 'zuora_entity_ids_example' # str | 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. (optional)
try:
# Update account
api_response = api_instance.p_ut_account(account_key, request, zuora_entity_ids=zuora_entity_ids)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->p_ut_account: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| account_key | str | Account number or account ID. | |
| request | PUTAccountType | ||
| zuora_entity_ids | str | An entity ID. If you have Zuora 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. | [optional] |
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]