Skip to content

jairov4/zuora-client

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
docs
docs
 
 
test
test
 
 
zuora_client
zuora_client
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
git_push.sh
git_push.sh
 
 
requirements.txt
requirements.txt
 
 
setup.py
setup.py
 
 
test-requirements.txt
test-requirements.txt
 
 
tox.ini
tox.ini
 
 

Repository files navigation

zuora-client

Introduction

Welcome to the reference for the Zuora REST API!

The Zuora REST API provides a broad set of operations and resources that:

  • Enable Web Storefront integration from your website.
  • Support self-service subscriber sign-ups and account management.
  • Process revenue schedules through custom revenue rule models.
  • Enable manipulation of most objects in the Zuora Object Model.

Want to share your opinion on how our API works for you?

API Feedback. Tell us how you feel about using our API and what we can do to make it better.

Access to the API

If you have a Zuora tenant, you can access the Zuora REST API via one of the following endpoints:

Tenant Base URL for REST Endpoints
US Production https://rest.zuora.com
US API Sandbox https://rest.apisandbox.zuora.com
US Performance Test https://rest.pt1.zuora.com
EU Production https://rest.eu.zuora.com
EU Sandbox https://rest.sandbox.eu.zuora.com

The Production endpoint provides access to your live user data. API Sandbox tenants are a good place to test code without affecting real-world data. If you would like Zuora to provision an API Sandbox tenant for you, contact your Zuora representative for assistance.

Note: If you have a tenant in the Production Copy Environment, submit a request at Zuora Global Support to enable the Zuora REST API in your tenant and obtain the base URL for REST endpoints. If you do not have a Zuora tenant, go to https://www.zuora.com/resource/zuora-test-drive and sign up for a Production Test Drive tenant. The tenant comes with seed data, including a sample product catalog.

API Changelog

You can find the Changelog of the API Reference in the Zuora Community.

Authentication

OAuth v2.0

Zuora recommends that you use OAuth v2.0 to authenticate to the Zuora REST API. Currently, OAuth is not available in every environment. See Zuora Testing Environments for more information. Zuora recommends you to create a dedicated API user with API write access on a tenant when authenticating via OAuth, and then create an OAuth client for this user. See Create an API User for how to do this. By creating a dedicated API user, you can control permissions of the API user without affecting other non-API users.

If a user is deactivated, all of the user's OAuth clients will be automatically deactivated.
Authenticating via OAuth requires the following steps:

  1. Create a Client
  2. Generate a Token
  3. Make Authenticated Requests

Create a Client

You must first create an OAuth client in the Zuora UI. To do this, you must be an administrator of your Zuora tenant. This is a one-time operation. You will be provided with a Client ID and a Client Secret. Please note this information down, as it will be required for the next step.

Note: The OAuth client will be owned by a Zuora user account. If you want to perform PUT, POST, or DELETE operations using the OAuth client, the owner of the OAuth client must have a Platform role that includes the API Write Access permission.

Generate a Token

After creating a client, you must make a call to obtain a bearer token using the Generate an OAuth token operation. This operation requires the following parameters:

  • client_id - the Client ID displayed when you created the OAuth client in the previous step
  • client_secret - the Client Secret displayed when you created the OAuth client in the previous step
  • grant_type - must be set to client_credentials

Note: The Client ID and Client Secret mentioned above were displayed when you created the OAuth Client in the prior step.

The Generate an OAuth token response specifies how long the bearer token is valid for. Call Generate an OAuth token again to generate a new bearer token.

Make Authenticated Requests

To authenticate subsequent API requests, you must provide a valid bearer token in an HTTP header:

Authorization: Bearer {bearer_token}

If you have Zuora Multi-entity enabled, you need to set an additional header to specify the ID of the entity that you want to access. You can use the scope field in the Generate an OAuth token response to determine whether you need to specify an entity ID. If the scope field contains more than one entity ID, you must specify the ID of the entity that you want to access.

For example, if the scope field contains entity.1a2b7a37-3e7d-4cb3-b0e2-883de9e766cc and entity.c92ed977-510c-4c48-9b51-8d5e848671e9, specify one of the following headers:

  • Zuora-Entity-Ids: 1a2b7a37-3e7d-4cb3-b0e2-883de9e766cc
  • Zuora-Entity-Ids: c92ed977-510c-4c48-9b51-8d5e848671e9

Note: For a limited period of time, Zuora will accept the entityId header as an alternative to the Zuora-Entity-Ids header. If you choose to set the entityId header, you must remove all "-" characters from the entity ID in the scope field.

If the scope field contains a single entity ID, you do not need to specify an entity ID.

Other Supported Authentication Schemes

Zuora continues to support the following additional legacy means of authentication:

Use username and password.

Include authentication with each request in the header:

  • apiAccessKeyId
  • apiSecretAccessKey

Zuora recommends that you create an API user specifically for making API calls. See Create an API User for more information.

Use an authorization cookie.

The cookie authorizes the user to make calls to the REST API for the duration specified in
Administration > Security Policies > Session timeout.

The cookie expiration time is reset with this duration after every call to the REST API. To obtain a cookie, call the Connections resource with the following API user information:

  • ID
  • Password
  • For CORS-enabled APIs only: Include a 'single-use' token in the request header, which re-authenticates the user with each request. See below for more details.

Entity Id and Entity Name

The entityId and entityName parameters are only used for [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity "Zuora Multi-entity"). These are the legacy parameters that Zuora will only continue to support for a period of time. Zuora recommends you to use the Zuora-Entity-Ids parameter instead.
The entityId and entityName parameters specify the Id and the [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name "Introduction to Entity and Entity Hierarchy") that you want to access, respectively. Note that you must have permission to access the entity.

You can specify either the entityId or entityName parameter in the authentication to access and view an entity.

  • If both entityId and entityName are specified in the authentication, an error occurs.
  • If neither entityId nor entityName is specified in the authentication, you will log in to the entity in which your user account is created.

To get the entity Id and entity name, you can use the GET Entities REST call. For more information, see [API User Authentication](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/A_Overview_of_Multi-entity#API_User_Authentication "API User Authentication").

Token Authentication for CORS-Enabled APIs

The CORS mechanism enables REST API calls to Zuora to be made directly from your customer's browser, with all credit card and security information transmitted directly to Zuora. This minimizes your PCI compliance burden, allows you to implement advanced validation on your payment forms, and makes your payment forms look just like any other part of your website.

For security reasons, instead of using cookies, an API request via CORS uses tokens for authentication.
The token method of authentication is only designed for use with requests that must originate from your customer's browser; it should not be considered a replacement to the existing cookie authentication mechanism.

See Zuora CORS REST for details on how CORS works and how you can begin to implement customer calls to the Zuora REST APIs. See HMAC Signatures for details on the HMAC method that returns the authentication token.

Requests and Responses

Request IDs

As a general rule, when asked to supply a "key" for an account or subscription (accountKey, account-key, subscriptionKey, subscription-key), you can provide either the actual ID or the number of the entity.

HTTP Request Body

Most of the parameters and data accompanying your requests will be contained in the body of the HTTP request.

The Zuora REST API accepts JSON in the HTTP request body. No other data format (e.g., XML) is supported.

Data Type

(Actions and CRUD operations only) We recommend that you do not specify the decimal values with quotation marks, commas, and spaces. Use characters of +-0-9.eE, for example, 5, 1.9, -8.469, and 7.7e2. Also, Zuora does not convert currencies for decimal values.

Testing a Request

Use a third party client, such as [curl](https://curl.haxx.se "curl"), [Postman](https://www.getpostman.com "Postman"), or [Advanced REST Client](https://advancedrestclient.com "Advanced REST Client"), to test the Zuora REST API. You can test the Zuora REST API from the Zuora API Sandbox or Production tenants. If connecting to Production, bear in mind that you are working with your live production data, not sample data or test data. ## Testing with Credit Cards Sooner or later it will probably be necessary to test some transactions that involve credit cards. For suggestions on how to handle this, see Going Live With Your Payment Gateway.

Concurrent Request Limits

Zuora enforces tenant-level concurrent request limits. See Concurrent Request Limits for more information.

Timeout Limit

If a request does not complete within 120 seconds, the request times out and Zuora returns a Gateway Timeout error.

Error Handling

Responses and error codes are detailed in Responses and errors.

Pagination

When retrieving information (using GET methods), the optional pageSize query parameter sets the maximum number of rows to return in a response. The maximum is 40; larger values are treated as 40. If this value is empty or invalid, pageSize typically defaults to 10.
The default value for the maximum number of rows retrieved can be overridden at the method level.
If more rows are available, the response will include a nextPage element, which contains a URL for requesting the next page. If this value is not provided, no more rows are available. No "previous page" element is explicitly provided; to support backward paging, use the previous call.

Array Size

For data items that are not paginated, the REST API supports arrays of up to 300 rows.
Thus, for instance, repeated pagination can retrieve thousands of customer accounts, but within any account an array of no more than 300 rate plans is returned.

API Versions

The 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.

Major Version

The major version number of the REST API appears in the REST URL. Currently, Zuora only supports the v1 major version. For example, POST https://rest.zuora.com/v1/subscriptions.

Minor Version

Zuora 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.
Some 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.

If 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.

If 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.

You 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.

For 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.

Minor Version History

The supported minor versions are not serial.

This section documents the changes made to each Zuora REST API minor version.

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 2018-08-23
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/jairov4/zuora-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/jairov4/zuora-client.git)

Then import the package:

import zuora_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import zuora_client

Getting Started

Please follow the installation procedure and then run the following:

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.AccountingCodesApi()
ac_id = 'ac_id_example' # str | ID of the accounting code you want to delete.
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:
    # Delete accounting code
    api_response = api_instance.d_elete_accounting_code(ac_id, zuora_entity_ids=zuora_entity_ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountingCodesApi->d_elete_accounting_code: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://rest.zuora.com

Class Method HTTP request Description
AccountingCodesApi d_elete_accounting_code DELETE /v1/accounting-codes/{ac-id} Delete accounting code
AccountingCodesApi g_et_accounting_code GET /v1/accounting-codes/{ac-id} Query an accounting code
AccountingCodesApi g_et_all_accounting_codes GET /v1/accounting-codes Get all accounting codes
AccountingCodesApi p_ost_accounting_code POST /v1/accounting-codes Create accounting code
AccountingCodesApi p_ut_accounting_code PUT /v1/accounting-codes/{ac-id} Update an accounting code
AccountingCodesApi p_ut_activate_accounting_code PUT /v1/accounting-codes/{ac-id}/activate Activate accounting code
AccountingCodesApi p_ut_deactivate_accounting_code PUT /v1/accounting-codes/{ac-id}/deactivate Deactivate accounting code
AccountingPeriodsApi d_elete_accounting_period DELETE /v1/accounting-periods/{ap-id} Delete accounting period
AccountingPeriodsApi g_et_accounting_period GET /v1/accounting-periods/{ap-id} Get accounting period
AccountingPeriodsApi g_et_all_accounting_periods GET /v1/accounting-periods Get all accounting periods
AccountingPeriodsApi p_ost_accounting_period POST /v1/accounting-periods Create accounting period
AccountingPeriodsApi p_ut_close_accounting_period PUT /v1/accounting-periods/{ap-id}/close Close accounting period
AccountingPeriodsApi p_ut_pending_close_accounting_period PUT /v1/accounting-periods/{ap-id}/pending-close Set accounting period to pending close
AccountingPeriodsApi p_ut_reopen_accounting_period PUT /v1/accounting-periods/{ap-id}/reopen Re-open accounting period
AccountingPeriodsApi p_ut_run_trial_balance PUT /v1/accounting-periods/{ap-id}/run-trial-balance Run trial balance
AccountingPeriodsApi p_ut_update_accounting_period PUT /v1/accounting-periods/{ap-id} Update accounting period
AccountsApi g_et_account GET /v1/accounts/{account-key} Get account
AccountsApi g_et_account_summary GET /v1/accounts/{account-key}/summary Get account summary
AccountsApi g_et_billing_document_files_deletion_job GET /v1/accounts/billing-documents/files/deletion-jobs/{jobId} Get job of hard deleting billing document files
AccountsApi object_delete_account DELETE /v1/object/account/{id} CRUD: Delete Account
AccountsApi object_get_account GET /v1/object/account/{id} CRUD: Retrieve Account
AccountsApi object_post_account POST /v1/object/account CRUD: Create Account
AccountsApi object_put_account PUT /v1/object/account/{id} CRUD: Update Account
AccountsApi p_ost_account POST /v1/accounts Create account
AccountsApi p_ost_billing_document_files_deletion_job POST /v1/accounts/billing-documents/files/deletion-jobs Create job to hard delete billing document files
AccountsApi p_ost_generate_billing_documents POST /v1/accounts/{id}/billing-documents/generate Generate billing documents by account
AccountsApi p_ut_account PUT /v1/accounts/{account-key} Update account
ActionsApi action_pos_tamend POST /v1/action/amend Amend
ActionsApi action_pos_tcreate POST /v1/action/create Create
ActionsApi action_pos_tdelete POST /v1/action/delete Delete
ActionsApi action_pos_texecute POST /v1/action/execute Execute
ActionsApi action_pos_tgenerate POST /v1/action/generate Generate
ActionsApi action_pos_tquery POST /v1/action/query Query
ActionsApi action_pos_tquery_more POST /v1/action/queryMore QueryMore
ActionsApi action_pos_tsubscribe POST /v1/action/subscribe Subscribe
ActionsApi action_pos_tupdate POST /v1/action/update Update
AmendmentsApi g_et_amendments_by_key GET /v1/amendments/{amendment-key} Get amendments by key
AmendmentsApi g_et_amendments_by_subscription_id GET /v1/amendments/subscriptions/{subscription-id} Get amendments by subscription ID
AmendmentsApi object_delete_amendment DELETE /v1/object/amendment/{id} CRUD: Delete amendment
AmendmentsApi object_get_amendment GET /v1/object/amendment/{id} CRUD: Get amendment
AmendmentsApi object_put_amendment PUT /v1/object/amendment/{id} CRUD: Update amendment
AttachmentsApi d_elete_attachments DELETE /v1/attachments/{attachment-id} Delete attachments
AttachmentsApi g_et_attachments GET /v1/attachments/{attachment-id} View attachments
AttachmentsApi g_et_attachments_list GET /v1/attachments/{object-type}/{object-key} View attachments list
AttachmentsApi p_ost_attachments POST /v1/attachments Add attachments
AttachmentsApi p_ut_attachments PUT /v1/attachments/{attachment-id} Edit attachments
BillRunApi object_delete_bill_run DELETE /v1/object/bill-run/{id} CRUD: Delete Bill Run
BillRunApi object_get_bill_run GET /v1/object/bill-run/{id} CRUD: Retrieve Bill Run
BillRunApi object_post_bill_run POST /v1/object/bill-run CRUD: Create Bill Run
BillRunApi object_put_bill_run PUT /v1/object/bill-run/{id} CRUD: Post or Cancel Bill Run
BillRunApi p_ost_email_billing_documentsfrom_bill_run POST /v1/bill-runs/{billRunId}/emails Email billing documents generated from bill run
BillingDocumentsApi g_et_billing_documents GET /v1/billing-documents Get billing documents
BillingPreviewRunApi g_et_billing_preview_run GET /v1/billing-preview-runs/{billingPreviewRunId} Get Billing Preview Run
BillingPreviewRunApi p_ost_billing_preview_run POST /v1/billing-preview-runs Create Billing Preview Run
CatalogApi g_et_catalog GET /v1/catalog/products Get product catalog
CatalogApi g_et_product GET /v1/catalog/product/{product-id} Get product
CatalogApi p_ost_catalog POST /v1/catalog/products/{product-id}/share Multi-entity: Share a product with an Entity
ChargeRevenueSummariesApi g_etcrs_by_charge_id GET /v1/charge-revenue-summaries/subscription-charges/{charge-key} Get charge summary details by charge ID
ChargeRevenueSummariesApi g_etcrs_by_crs_number GET /v1/charge-revenue-summaries/{crs-number} Get charge summary details by CRS number
CommunicationProfilesApi object_get_communication_profile GET /v1/object/communication-profile/{id} CRUD: Retrieve CommunicationProfile
ConnectionsApi p_ost_connections POST /v1/connections Establish connection to Zuora REST API service
ContactsApi object_delete_contact DELETE /v1/object/contact/{id} CRUD: Delete Contact
ContactsApi object_get_contact GET /v1/object/contact/{id} CRUD: Retrieve Contact
ContactsApi object_post_contact POST /v1/object/contact CRUD: Create Contact
ContactsApi object_put_contact PUT /v1/object/contact/{id} CRUD: Update Contact
CreditBalanceAdjustmentsApi object_get_credit_balance_adjustment GET /v1/object/credit-balance-adjustment/{id} CRUD: Retrieve CreditBalanceAdjustment
CreditMemosApi d_elete_credit_memo DELETE /v1/creditmemos/{creditMemoId} Delete credit memo
CreditMemosApi g_et_breakdown_credit_memo_by_order GET /v1/creditmemos/{creditMemoNumber}/amountBreakdownByOrder Get breakdown of credit memo by order
CreditMemosApi g_et_credit_memo GET /v1/creditmemos/{creditMemoId} Get credit memo
CreditMemosApi g_et_credit_memo_item GET /v1/creditmemos/{creditMemoId}/items/{cmitemid} Get credit memo item
CreditMemosApi g_et_credit_memo_item_part GET /v1/creditmemos/{creditMemoId}/parts/{partid}/itemparts/{itempartid} Get credit memo part item
CreditMemosApi g_et_credit_memo_item_parts GET /v1/creditmemos/{creditMemoId}/parts/{partid}/itemparts Get credit memo part items
CreditMemosApi g_et_credit_memo_items GET /v1/creditmemos/{creditMemoId}/items Get credit memo items
CreditMemosApi g_et_credit_memo_part GET /v1/creditmemos/{creditMemoId}/parts/{partid} Get credit memo part
CreditMemosApi g_et_credit_memo_parts GET /v1/creditmemos/{creditMemoId}/parts Get credit memo parts
CreditMemosApi g_et_credit_memos GET /v1/creditmemos Get credit memos
CreditMemosApi p_ost_credit_memo_from_prpc POST /v1/creditmemos Create credit memo from charge
CreditMemosApi p_ost_credit_memo_pdf POST /v1/creditmemos/{creditMemoId}/pdfs Create credit memo PDF
CreditMemosApi p_ost_email_credit_memo POST /v1/creditmemos/{creditMemoId}/emails Email credit memo
CreditMemosApi p_ost_refund_credit_memo POST /v1/creditmemos/{creditmemoId}/refunds Refund credit memo
CreditMemosApi p_ostcm_taxation_items POST /v1/creditmemos/{creditMemoId}/taxationitems Create taxation items for credit memo
CreditMemosApi p_ut_apply_credit_memo PUT /v1/creditmemos/{creditMemoId}/apply Apply credit memo
CreditMemosApi p_ut_cancel_credit_memo PUT /v1/creditmemos/{creditMemoId}/cancel Cancel credit memo
CreditMemosApi p_ut_post_credit_memo PUT /v1/creditmemos/{creditMemoId}/post Post credit memo
CreditMemosApi p_ut_unapply_credit_memo PUT /v1/creditmemos/{creditMemoId}/unapply Unapply credit memo
CreditMemosApi p_ut_unpost_credit_memo PUT /v1/creditmemos/{creditMemoId}/unpost Unpost credit memo
CreditMemosApi p_ut_update_credit_memo PUT /v1/creditmemos/{creditMemoId} Update credit memo
CustomExchangeRatesApi g_et_custom_exchange_rates GET /v1/custom-exchange-rates/{currency} Get custom foreign currency exchange rates
DebitMemosApi d_elete_debit_memo DELETE /v1/debitmemos/{debitMemoId} Delete debit memo
DebitMemosApi g_et_debit_memo GET /v1/debitmemos/{debitMemoId} Get debit memo
DebitMemosApi g_et_debit_memo_application_parts GET /v1/debitmemos/{debitMemoId}/application-parts Get debit memo application parts
DebitMemosApi g_et_debit_memo_item GET /v1/debitmemos/{debitMemoId}/items/{dmitemid} Get debit memo item
DebitMemosApi g_et_debit_memo_items GET /v1/debitmemos/{debitMemoId}/items Get debit memo items
DebitMemosApi g_et_debit_memos GET /v1/debitmemos Get debit memos
DebitMemosApi p_ost_debit_memo_from_prpc POST /v1/debitmemos Create debit memo from charge
DebitMemosApi p_ost_debit_memo_pdf POST /v1/debitmemos/{debitMemoId}/pdfs Create debit memo PDF
DebitMemosApi p_ost_email_debit_memo POST /v1/debitmemos/{debitMemoId}/emails Email debit memo
DebitMemosApi p_ostdm_taxation_items POST /v1/debitmemos/{debitMemoId}/taxationitems Create taxation items for debit memo
DebitMemosApi p_ut_batch_update_debit_memos PUT /v1/debitmemos Update debit memos
DebitMemosApi p_ut_cancel_debit_memo PUT /v1/debitmemos/{debitMemoId}/cancel Cancel debit memo
DebitMemosApi p_ut_debit_memo PUT /v1/debitmemos/{debitMemoId} Update debit memo
DebitMemosApi p_ut_post_debit_memo PUT /v1/debitmemos/{debitMemoId}/post Post debit memo
DebitMemosApi p_ut_unpost_debit_memo PUT /v1/debitmemos/{debitMemoId}/unpost Unpost debit memo
DescribeApi g_et_describe GET /v1/describe/{object} Describe object
EntitiesApi d_elete_entities DELETE /v1/entities/{id} Multi-entity: Delete entity
EntitiesApi g_et_entities GET /v1/entities Multi-entity: Get entities
EntitiesApi g_et_entity_by_id GET /v1/entities/{id} Multi-entity: Get entity by Id
EntitiesApi p_ost_entities POST /v1/entities Multi-entity: Create entity
EntitiesApi p_ut_entities PUT /v1/entities/{id} Multi-entity: Update entity
EntitiesApi p_ut_provision_entity PUT /v1/entities/{id}/provision Multi-entity: Provision entity
EntityConnectionsApi g_et_entity_connections GET /v1/entity-connections Multi-entity: Get connections
EntityConnectionsApi p_ost_entity_connections POST /v1/entity-connections Multi-entity: Initiate connection
EntityConnectionsApi p_ut_entity_connections_accept PUT /v1/entity-connections/{connection-id}/accept Multi-entity: Accept connection
EntityConnectionsApi p_ut_entity_connections_deny PUT /v1/entity-connections/{connection-id}/deny Multi-entity: Deny connection
EntityConnectionsApi p_ut_entity_connections_disconnect PUT /v1/entity-connections/{connection-id}/disconnect Multi-entity: Disconnect connection
EventTriggersApi d_elete_event_trigger DELETE /events/event-triggers/{id} Remove an event trigger
EventTriggersApi g_et_event_trigger GET /events/event-triggers/{id} Get an event trigger by ID
EventTriggersApi g_et_event_triggers GET /events/event-triggers Query event triggers
EventTriggersApi p_ost_event_trigger POST /events/event-triggers Create an event trigger
EventTriggersApi p_ut_event_trigger PUT /events/event-triggers/{id} Update an event trigger
ExportsApi object_get_export GET /v1/object/export/{id} CRUD: Retrieve Export
ExportsApi object_post_export POST /v1/object/export CRUD: Create Export
FeaturesApi object_delete_feature DELETE /v1/object/feature/{id} CRUD: Delete Feature
FeaturesApi object_get_feature GET /v1/object/feature/{id} CRUD: Retrieve Feature
GetFilesApi g_et_files GET /v1/files/{file-id} Get files
HMACSignaturesApi p_osthmac_signatures POST /v1/hmac-signatures Return HMAC signatures
HostedPagesApi get_hosted_pages GET /v1/hostedpages Return hosted pages
ImportsApi object_get_import GET /v1/object/import/{id} CRUD: Retrieve Import
ImportsApi object_post_import POST /v1/object/import CRUD: Create Import
InvoiceAdjustmentsApi object_delete_invoice_adjustment DELETE /v1/object/invoice-adjustment/{id} CRUD: Delete InvoiceAdjustment
InvoiceAdjustmentsApi object_get_invoice_adjustment GET /v1/object/invoice-adjustment/{id} CRUD: Retrieve InvoiceAdjustment
InvoiceAdjustmentsApi object_post_invoice_adjustment POST /v1/object/invoice-adjustment CRUD: Create InvoiceAdjustment
InvoiceAdjustmentsApi object_put_invoice_adjustment PUT /v1/object/invoice-adjustment/{id} CRUD: Update InvoiceAdjustment
InvoiceItemAdjustmentsApi object_delete_invoice_item_adjustment DELETE /v1/object/invoice-item-adjustment/{id} CRUD: Delete InvoiceItemAdjustment
InvoiceItemAdjustmentsApi object_get_invoice_item_adjustment GET /v1/object/invoice-item-adjustment/{id} CRUD: Retrieve InvoiceItemAdjustment
InvoiceItemsApi object_get_invoice_item GET /v1/object/invoice-item/{id} CRUD: Retrieve InvoiceItem
InvoicePaymentsApi object_get_invoice_payment GET /v1/object/invoice-payment/{id} CRUD: Retrieve InvoicePayment
InvoicePaymentsApi object_post_invoice_payment POST /v1/object/invoice-payment CRUD: Create InvoicePayment
InvoicePaymentsApi object_put_invoice_payment PUT /v1/object/invoice-payment/{id} CRUD: Update InvoicePayment
InvoiceSplitItemsApi object_get_invoice_split_item GET /v1/object/invoice-split-item/{id} CRUD: Retrieve InvoiceSplitItem
InvoiceSplitsApi object_get_invoice_split GET /v1/object/invoice-split/{id} CRUD: Retrieve InvoiceSplit
InvoicesApi g_et_invoice_application_parts GET /v1/invoices/{invoiceId}/application-parts Get invoice application parts
InvoicesApi g_et_invoice_files GET /v1/invoices/{invoice-id}/files Get invoice files
InvoicesApi g_et_invoice_items GET /v1/invoices/{invoice-id}/items Get invoice items
InvoicesApi object_delete_invoice DELETE /v1/object/invoice/{id} CRUD: Delete Invoice
InvoicesApi object_get_invoice GET /v1/object/invoice/{id} CRUD: Retrieve Invoice
InvoicesApi object_put_invoice PUT /v1/object/invoice/{id} CRUD: Update Invoice
InvoicesApi p_ost_credit_memo_from_invoice POST /v1/invoices/{invoiceId}/creditmemos Create credit memo from invoice
InvoicesApi p_ost_debit_memo_from_invoice POST /v1/invoices/{invoiceId}/debitmemos Create debit memo from invoice
InvoicesApi p_ost_email_invoice POST /v1/invoices/{invoiceId}/emails Email invoice
InvoicesApi p_ut_batch_update_invoices PUT /v1/invoices Update invoices
InvoicesApi p_ut_reverse_invoice PUT /v1/invoices/{invoiceId}/reverse Reverse invoice
InvoicesApi p_ut_update_invoice PUT /v1/invoices/{invoiceId} Update invoice
InvoicesApi p_ut_write_off_invoice PUT /v1/invoices/{invoiceId}/write-off Write off invoice
JournalRunsApi d_elete_journal_run DELETE /v1/journal-runs/{jr-number} Delete journal run
JournalRunsApi g_et_journal_run GET /v1/journal-runs/{jr-number} Get journal run
JournalRunsApi p_ost_journal_run POST /v1/journal-runs Create journal run
JournalRunsApi p_ut_journal_run PUT /v1/journal-runs/{jr-number}/cancel Cancel journal run
MassUpdaterApi g_et_mass_updater GET /v1/bulk/{bulk-key} Get mass action result
MassUpdaterApi p_ost_mass_updater POST /v1/bulk Perform mass action
MassUpdaterApi p_ut_mass_updater PUT /v1/bulk/{bulk-key}/stop Stop mass action
NotificationsApi d_elete_delete_email_template DELETE /notifications/email-templates/{id} Delete an email template
NotificationsApi d_elete_delete_notification_definition DELETE /notifications/notification-definitions/{id} Delete a notification definition
NotificationsApi g_et_callout_history GET /v1/notification-history/callout Get callout notification histories
NotificationsApi g_et_email_history GET /v1/notification-history/email Get email notification histories
NotificationsApi g_et_get_email_template GET /notifications/email-templates/{id} Get an email template
NotificationsApi g_et_get_notification_definition GET /notifications/notification-definitions/{id} Get a notification definition
NotificationsApi g_et_query_email_templates GET /notifications/email-templates Query email templates
NotificationsApi g_et_query_notification_definitions GET /notifications/notification-definitions Query notification definitions
NotificationsApi p_ost_create_email_template POST /notifications/email-templates Create an email template
NotificationsApi p_ost_create_notification_definition POST /notifications/notification-definitions Create a notification definition
NotificationsApi p_ut_update_email_template PUT /notifications/email-templates/{id} Update an email template
NotificationsApi p_ut_update_notification_definition PUT /notifications/notification-definitions/{id} Update a notification definition
OAuthApi create_token POST /oauth/token Generate an OAuth token
OperationsApi p_ost_billing_preview POST /v1/operations/billing-preview Create billing preview
OperationsApi p_ost_transaction_invoice_payment POST /v1/operations/invoice-collect Invoice and collect
OrdersApi d_elete_order DELETE /v1/orders/{orderNumber} Delete order
OrdersApi g_et_all_orders GET /v1/orders Get all orders
OrdersApi g_et_breakdown_invoice_by_order GET /v1/invoices/{invoiceNumber}/amountBreakdownByOrder Get breakdown of invoice by order
OrdersApi g_et_order GET /v1/orders/{orderNumber} Get an order
OrdersApi g_et_order_billing_info GET /v1/orders/{orderNumber}/billingInfo Get billing information for order
OrdersApi g_et_order_metricsfor_evergreen_subscription GET /v1/orders/{orderNumber}/evergreenMetrics/{subscriptionNumber} Get order metrics for evergreen subscription
OrdersApi g_et_order_rated_result GET /v1/orders/{orderNumber}/ratedResults Get rated result for order
OrdersApi g_et_orders_by_invoice_owner GET /v1/orders/invoiceOwner/{accountNumber} Get orders by invoice owner
OrdersApi g_et_orders_by_subscription_number GET /v1/orders/subscription/{subscriptionNumber} Get orders by subscription number
OrdersApi g_et_orders_by_subscription_owner GET /v1/orders/subscriptionOwner/{accountNumber} Get orders by subscription owner
OrdersApi g_et_subscription_term_info GET /v1/orders/term/{subscriptionNumber} Get term information for subscription
OrdersApi p_ost_order POST /v1/orders Create order
OrdersApi p_ost_preview_order POST /v1/orders/preview Preview order
OrdersApi p_ut_order_trigger_dates PUT /v1/orders/{orderNumber}/triggerDates Update order action trigger dates
OrdersApi p_ut_update_order_custom_fields PUT /v1/orders/{orderNumber}/customFields Update order custom fields
OrdersApi p_ut_update_subscription_custom_fields PUT /v1/subscriptions/{subscriptionNumber}/customFields Update subscription custom fields
PaymentGatewaysApi g_et_paymentgateways GET /v1/paymentgateways Get payment gateways
PaymentMethodSnapshotsApi object_delete_payment_method_snapshot DELETE /v1/object/payment-method-snapshot/{id} CRUD: Delete PaymentMethodSnapshot
PaymentMethodSnapshotsApi object_get_payment_method_snapshot GET /v1/object/payment-method-snapshot/{id} CRUD: Retrieve PaymentMethodSnapshot
PaymentMethodTransactionLogsApi object_get_payment_method_transaction_log GET /v1/object/payment-method-transaction-log/{id} CRUD: Retrieve PaymentMethodTransactionLog
PaymentMethodsApi d_elete_payment_methods DELETE /v1/payment-methods/{payment-method-id} Delete payment method
PaymentMethodsApi g_et_payment_methods_credit_card GET /v1/payment-methods/credit-cards/accounts/{account-key} Get credit card payment methods for account
PaymentMethodsApi object_delete_payment_method DELETE /v1/object/payment-method/{id} CRUD: Delete payment method
PaymentMethodsApi object_get_payment_method GET /v1/object/payment-method/{id} CRUD: Get payment method
PaymentMethodsApi object_post_payment_method POST /v1/object/payment-method CRUD: Create payment method
PaymentMethodsApi object_put_payment_method PUT /v1/object/payment-method/{id} CRUD: Update payment method
PaymentMethodsApi p_ost_cancel_authorization POST /v1/payment-methods/{payment-method-id}/voidAuthorize Cancel authorization
PaymentMethodsApi p_ost_create_authorization POST /v1/payment-methods/{payment-method-id}/authorize Create authorization
PaymentMethodsApi p_ost_payment_methods POST /v1/payment-methods Create payment method
PaymentMethodsApi p_ost_payment_methods_credit_card POST /v1/payment-methods/credit-cards Create credit card payment method
PaymentMethodsApi p_ost_payment_methods_decryption POST /v1/payment-methods/decryption Create Apple Pay payment method
PaymentMethodsApi p_ut_payment_methods_credit_card PUT /v1/payment-methods/credit-cards/{payment-method-id} Update credit card payment method
PaymentMethodsApi p_ut_scrub_payment_methods PUT /v1/payment-methods/{payment-method-id}/scrub Scrub payment method
PaymentMethodsApi p_ut_verify_payment_methods PUT /v1/payment-methods/{payment-method-id}/verify Verify payment method
PaymentRunsApi d_elete_payment_run DELETE /v1/payment-runs/{paymentRunId} Delete payment run
PaymentRunsApi g_et_payment_run GET /v1/payment-runs/{paymentRunId} Get payment run
PaymentRunsApi g_et_payment_run_summary GET /v1/payment-runs/{paymentRunId}/summary Get payment run summary
PaymentRunsApi g_et_payment_runs GET /v1/payment-runs Get payment runs
PaymentRunsApi p_ost_payment_run POST /v1/payment-runs Create payment run
PaymentRunsApi p_ut_payment_run PUT /v1/payment-runs/{paymentRunId} Update payment run
PaymentTransactionLogsApi object_get_payment_transaction_log GET /v1/object/payment-transaction-log/{id} CRUD: Get payment transaction log
PaymentsApi d_elete_payment DELETE /v1/payments/{paymentId} Delete payment
PaymentsApi g_et_payment GET /v1/payments/{paymentId} Get payment
PaymentsApi g_et_payment_item_part GET /v1/payments/{paymentId}/parts/{partid}/itemparts/{itempartid} Get payment part item
PaymentsApi g_et_payment_item_parts GET /v1/payments/{paymentId}/parts/{partid}/itemparts Get payment part items
PaymentsApi g_et_payment_part GET /v1/payments/{paymentId}/parts/{partid} Get payment part
PaymentsApi g_et_payment_parts GET /v1/payments/{paymentId}/parts Get payment parts
PaymentsApi g_et_retrieve_all_payments GET /v1/payments Get all payments
PaymentsApi object_delete_payment DELETE /v1/object/payment/{id} CRUD: Delete payment
PaymentsApi object_get_payment GET /v1/object/payment/{id} CRUD: Get payment
PaymentsApi object_post_payment POST /v1/object/payment CRUD: Create payment
PaymentsApi object_put_payment PUT /v1/object/payment/{id} CRUD: Update payment
PaymentsApi p_ost_create_payment POST /v1/payments Create payment
PaymentsApi p_ost_refund_payment POST /v1/payments/{paymentId}/refunds Refund payment
PaymentsApi p_ut_apply_payment PUT /v1/payments/{paymentId}/apply Apply payment
PaymentsApi p_ut_cancel_payment PUT /v1/payments/{paymentId}/cancel Cancel payment
PaymentsApi p_ut_transfer_payment PUT /v1/payments/{paymentId}/transfer Transfer payment
PaymentsApi p_ut_unapply_payment PUT /v1/payments/{paymentId}/unapply Unapply payment
PaymentsApi p_ut_update_payment PUT /v1/payments/{paymentId} Update payment
ProductFeaturesApi object_delete_product_feature DELETE /v1/object/product-feature/{id} CRUD: Delete ProductFeature
ProductFeaturesApi object_get_product_feature GET /v1/object/product-feature/{id} CRUD: Retrieve ProductFeature
ProductRatePlanChargeTiersApi object_get_product_rate_plan_charge_tier GET /v1/object/product-rate-plan-charge-tier/{id} CRUD: Retrieve ProductRatePlanChargeTier
ProductRatePlanChargesApi object_delete_product_rate_plan_charge DELETE /v1/object/product-rate-plan-charge/{id} CRUD: Delete product rate plan charge
ProductRatePlanChargesApi object_get_product_rate_plan_charge GET /v1/object/product-rate-plan-charge/{id} CRUD: Get product rate plan charge
ProductRatePlanChargesApi object_post_product_rate_plan_charge POST /v1/object/product-rate-plan-charge CRUD: Create product rate plan charge
ProductRatePlanChargesApi object_put_product_rate_plan_charge PUT /v1/object/product-rate-plan-charge/{id} CRUD: Update product rate plan charge
ProductRatePlansApi g_et_product_rate_plans GET /v1/rateplan/{product_id}/productRatePlan Get product rate plans
ProductRatePlansApi object_delete_product_rate_plan DELETE /v1/object/product-rate-plan/{id} CRUD: Delete ProductRatePlan
ProductRatePlansApi object_get_product_rate_plan GET /v1/object/product-rate-plan/{id} CRUD: Retrieve ProductRatePlan
ProductRatePlansApi object_post_product_rate_plan POST /v1/object/product-rate-plan CRUD: Create ProductRatePlan
ProductRatePlansApi object_put_product_rate_plan PUT /v1/object/product-rate-plan/{id} CRUD: Update ProductRatePlan
ProductsApi object_delete_product DELETE /v1/object/product/{id} CRUD: Delete Product
ProductsApi object_get_product GET /v1/object/product/{id} CRUD: Retrieve Product
ProductsApi object_post_product POST /v1/object/product CRUD: Create Product
ProductsApi object_put_product PUT /v1/object/product/{id} CRUD: Update Product
QuotesDocumentApi p_ost_quotes_document POST /v1/quotes/document Generate quotes document
RSASignaturesApi p_ost_decrypt_rsa_signatures POST /v1/rsa-signatures/decrypt Decrypt RSA signature
RSASignaturesApi p_ostrsa_signatures POST /v1/rsa-signatures Generate RSA signature
RatePlanChargeTiersApi object_get_rate_plan_charge_tier GET /v1/object/rate-plan-charge-tier/{id} CRUD: Retrieve RatePlanChargeTier
RatePlanChargesApi object_get_rate_plan_charge GET /v1/object/rate-plan-charge/{id} CRUD: Retrieve RatePlanCharge
RatePlansApi object_get_rate_plan GET /v1/object/rate-plan/{id} CRUD: Retrieve RatePlan
RefundInvoicePaymentsApi object_get_refund_invoice_payment GET /v1/object/refund-invoice-payment/{id} CRUD: Retrieve RefundInvoicePayment
RefundTransactionLogsApi object_get_refund_transaction_log GET /v1/object/refund-transaction-log/{id} CRUD: Retrieve RefundTransactionLog
RefundsApi d_elete_refund DELETE /v1/refunds/{refundId} Delete refund
RefundsApi g_et_refund GET /v1/refunds/{refundId} Get refund
RefundsApi g_et_refund_item_part GET /v1/refunds/{refundId}/parts/{refundpartid}/itemparts/{itempartid} Get refund part item
RefundsApi g_et_refund_item_parts GET /v1/refunds/{refundId}/parts/{refundpartid}/itemparts Get refund part items
RefundsApi g_et_refund_part GET /v1/refunds/{refundId}/parts/{refundpartid} Get refund part
RefundsApi g_et_refund_parts GET /v1/refunds/{refundId}/parts Get refund parts
RefundsApi g_et_refunds GET /v1/refunds Get all refunds
RefundsApi object_delete_refund DELETE /v1/object/refund/{id} CRUD: Delete refund
RefundsApi object_get_refund GET /v1/object/refund/{id} CRUD: Get refund
RefundsApi object_post_refund POST /v1/object/refund CRUD: Create refund
RefundsApi object_put_refund PUT /v1/object/refund/{id} CRUD: Update refund
RefundsApi p_ut_cancel_refund PUT /v1/refunds/{refundId}/cancel Cancel refund
RefundsApi p_ut_update_refund PUT /v1/refunds/{refundId} Update refund
RevenueEventsApi g_et_revenue_event_details GET /v1/revenue-events/{event-number} Get revenue event details
RevenueEventsApi g_et_revenue_event_for_revenue_schedule GET /v1/revenue-events/revenue-schedules/{rs-number} Get revenue events for a revenue schedule
RevenueItemsApi g_et_revenue_items_by_charge_revenue_event_number GET /v1/revenue-items/revenue-events/{event-number} Get revenue items by revenue event number
RevenueItemsApi g_et_revenue_items_by_charge_revenue_summary_number GET /v1/revenue-items/charge-revenue-summaries/{crs-number} Get revenue items by charge revenue summary number
RevenueItemsApi g_et_revenue_items_by_revenue_schedule GET /v1/revenue-items/revenue-schedules/{rs-number} Get revenue items by revenue schedule
RevenueItemsApi p_ut_custom_fieldson_revenue_items_by_revenue_event PUT /v1/revenue-items/revenue-events/{event-number} Update custom fields on revenue items by revenue event number
RevenueItemsApi p_ut_custom_fieldson_revenue_items_by_revenue_schedule PUT /v1/revenue-items/revenue-schedules/{rs-number} Update custom fields on revenue items by revenue schedule number
RevenueRulesApi g_et_revenue_rec_ruleby_product_rate_plan_charge GET /v1/revenue-recognition-rules/product-charges/{charge-key} Get revenue recognition rule by product rate plan charge
RevenueRulesApi g_et_revenue_rec_rules GET /v1/revenue-recognition-rules/subscription-charges/{charge-key} Get revenue recognition rule by subscription charge
RevenueSchedulesApi d_eleters DELETE /v1/revenue-schedules/{rs-number} Delete revenue schedule
RevenueSchedulesApi g_etr_sby_credit_memo_item GET /v1/revenue-schedules/credit-memo-items/{cmi-id} Get revenue schedule by credit memo item ID
RevenueSchedulesApi g_etr_sby_debit_memo_item GET /v1/revenue-schedules/debit-memo-items/{dmi-id} Get revenue schedule by debit memo item ID
RevenueSchedulesApi g_etr_sby_invoice_item GET /v1/revenue-schedules/invoice-items/{invoice-item-id} Get revenue schedule by invoice item ID
RevenueSchedulesApi g_etr_sby_invoice_item_adjustment GET /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key} Get revenue schedule by invoice item adjustment
RevenueSchedulesApi g_etr_sby_product_charge_and_billing_account GET /v1/revenue-schedules/product-charges/{charge-key}/{account-key} Get all revenue schedules of product charge by charge ID and billing account ID
RevenueSchedulesApi g_etr_sfor_subsc_charge GET /v1/revenue-schedules/subscription-charges/{charge-key} Get revenue schedule by subscription charge
RevenueSchedulesApi g_etrs GET /v1/revenue-schedules/{rs-number} Get revenue schedule details
RevenueSchedulesApi p_ostr_sfor_credit_memo_item_distribute_by_date_range POST /v1/revenue-schedules/credit-memo-items/{cmi-id}/distribute-revenue-with-date-range Create revenue schedule for credit memo item (distribute by date range)
RevenueSchedulesApi p_ostr_sfor_credit_memo_item_manual_distribution POST /v1/revenue-schedules/credit-memo-items/{cmi-id} Create revenue schedule for credit memo item (manual distribution)
RevenueSchedulesApi p_ostr_sfor_debit_memo_item_distribute_by_date_range POST /v1/revenue-schedules/debit-memo-items/{dmi-id}/distribute-revenue-with-date-range Create revenue schedule for debit memo item (distribute by date range)
RevenueSchedulesApi p_ostr_sfor_debit_memo_item_manual_distribution POST /v1/revenue-schedules/debit-memo-items/{dmi-id} Create revenue schedule for debit memo item (manual distribution)
RevenueSchedulesApi p_ostr_sfor_invoice_item_adjustment_distribute_by_date_range POST /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key}/distribute-revenue-with-date-range Create revenue schedule for Invoice Item Adjustment (distribute by date range)
RevenueSchedulesApi p_ostr_sfor_invoice_item_adjustment_manual_distribution POST /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key} Create revenue schedule for Invoice Item Adjustment (manual distribution)
RevenueSchedulesApi p_ostr_sfor_invoice_item_distribute_by_date_range POST /v1/revenue-schedules/invoice-items/{invoice-item-id}/distribute-revenue-with-date-range Create revenue schedule for Invoice Item (distribute by date range)
RevenueSchedulesApi p_ostr_sfor_invoice_item_manual_distribution POST /v1/revenue-schedules/invoice-items/{invoice-item-id} Create revenue schedule for Invoice Item (manual distribution)
RevenueSchedulesApi p_ostr_sfor_subsc_charge POST /v1/revenue-schedules/subscription-charges/{charge-key} Create revenue schedule on subscription charge
RevenueSchedulesApi p_ut_revenue_across_ap PUT /v1/revenue-schedules/{rs-number}/distribute-revenue-across-accounting-periods Distribute revenue across accounting periods
RevenueSchedulesApi p_ut_revenue_by_recognition_startand_end_dates PUT /v1/revenue-schedules/{rs-number}/distribute-revenue-with-date-range Distribute revenue by recognition start and end dates
RevenueSchedulesApi p_ut_revenue_specific_date PUT /v1/revenue-schedules/{rs-number}/distribute-revenue-on-specific-date Distribute revenue on specific date
RevenueSchedulesApi p_utrs_basic_info PUT /v1/revenue-schedules/{rs-number}/basic-information Update revenue schedule basic information
SettingsApi g_et_revenue_automation_start_date GET /v1/settings/finance/revenue-automation-start-date Get the revenue automation start date
SubscriptionProductFeaturesApi object_get_subscription_product_feature GET /v1/object/subscription-product-feature/{id} CRUD: Retrieve SubscriptionProductFeature
SubscriptionsApi g_et_subscriptions_by_account GET /v1/subscriptions/accounts/{account-key} Get subscriptions by account
SubscriptionsApi g_et_subscriptions_by_key GET /v1/subscriptions/{subscription-key} Get subscriptions by key
SubscriptionsApi g_et_subscriptions_by_key_and_version GET /v1/subscriptions/{subscription-key}/versions/{version} Get subscriptions by key and version
SubscriptionsApi object_delete_subscription DELETE /v1/object/subscription/{id} CRUD: Delete Subscription
SubscriptionsApi object_get_subscription GET /v1/object/subscription/{id} CRUD: Retrieve Subscription
SubscriptionsApi object_put_subscription PUT /v1/object/subscription/{id} CRUD: Update Subscription
SubscriptionsApi p_ost_preview_subscription POST /v1/subscriptions/preview Preview subscription
SubscriptionsApi p_ost_subscription POST /v1/subscriptions Create subscription
SubscriptionsApi p_ut_cancel_subscription PUT /v1/subscriptions/{subscription-key}/cancel Cancel subscription
SubscriptionsApi p_ut_renew_subscription PUT /v1/subscriptions/{subscription-key}/renew Renew subscription
SubscriptionsApi p_ut_resume_subscription PUT /v1/subscriptions/{subscription-key}/resume Resume subscription
SubscriptionsApi p_ut_subscription PUT /v1/subscriptions/{subscription-key} Update subscription
SubscriptionsApi p_ut_suspend_subscription PUT /v1/subscriptions/{subscription-key}/suspend Suspend subscription
SummaryJournalEntriesApi d_elete_summary_journal_entry DELETE /v1/journal-entries/{je-number} Delete summary journal entry
SummaryJournalEntriesApi g_et_all_summary_journal_entries GET /v1/journal-entries/journal-runs/{jr-number} Get all summary journal entries in a journal run
SummaryJournalEntriesApi g_et_summary_journal_entry GET /v1/journal-entries/{je-number} Get summary journal entry
SummaryJournalEntriesApi p_ost_summary_journal_entry POST /v1/journal-entries Create summary journal entry
SummaryJournalEntriesApi p_ut_basic_summary_journal_entry PUT /v1/journal-entries/{je-number}/basic-information Update basic information of a summary journal entry
SummaryJournalEntriesApi p_ut_summary_journal_entry PUT /v1/journal-entries/{je-number}/cancel Cancel summary journal entry
TaxationItemsApi d_elete_taxation_item DELETE /v1/taxationitems/{id} Delete taxation item
TaxationItemsApi g_et_taxation_item GET /v1/taxationitems/{id} Get taxation item
TaxationItemsApi object_delete_taxation_item DELETE /v1/object/taxation-item/{id} CRUD: Delete TaxationItem
TaxationItemsApi object_get_taxation_item GET /v1/object/taxation-item/{id} CRUD: Retrieve TaxationItem
TaxationItemsApi object_post_taxation_item POST /v1/object/taxation-item CRUD: Create TaxationItem
TaxationItemsApi object_put_taxation_item PUT /v1/object/taxation-item/{id} CRUD: Update TaxationItem
TaxationItemsApi p_ut_taxation_item PUT /v1/taxationitems/{id} Update taxation item
TransactionsApi g_et_transaction_invoice GET /v1/transactions/invoices/accounts/{account-key} Get invoices
TransactionsApi g_et_transaction_payment GET /v1/transactions/payments/accounts/{account-key} Get payments
UnitOfMeasureApi object_delete_unit_of_measure DELETE /v1/object/unit-of-measure/{id} CRUD: Delete UnitOfMeasure
UnitOfMeasureApi object_get_unit_of_measure GET /v1/object/unit-of-measure/{id} CRUD: Retrieve UnitOfMeasure
UnitOfMeasureApi object_post_unit_of_measure POST /v1/object/unit-of-measure CRUD: Create UnitOfMeasure
UnitOfMeasureApi object_put_unit_of_measure PUT /v1/object/unit-of-measure/{id} CRUD: Update UnitOfMeasure
UsageApi g_et_usage GET /v1/usage/accounts/{account-key} Get usage
UsageApi object_delete_usage DELETE /v1/object/usage/{id} CRUD: Delete Usage
UsageApi object_get_usage GET /v1/object/usage/{id} CRUD: Retrieve Usage
UsageApi object_post_usage POST /v1/object/usage CRUD: Create Usage
UsageApi object_put_usage PUT /v1/object/usage/{id} CRUD: Update Usage
UsageApi p_ost_usage POST /v1/usage Post usage
UsersApi g_et_entities_user_accessible GET /v1/users/{username}/accessible-entities Multi-entity: Get entities that a user can access
UsersApi p_ut_accept_user_access PUT /v1/users/{username}/accept-access Multi-entity: Accept user access
UsersApi p_ut_deny_user_access PUT /v1/users/{username}/deny-access Multi-entity: Deny user access
UsersApi p_ut_send_user_access_requests PUT /v1/users/{username}/request-access Multi-entity: Send user access requests

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

docs@zuora.com

About

Python Zuora client for REST API

Topics

client rest-api swagger zuora

Resources

Readme
Activity

Stars

1 star

Watchers

2 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Languages