> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Zuora

> How to set up the Zuora connector, plus the actions and events that are available.

![Zuora](https://stackone-logos.com/api/zuora/filled/svg)

Betav2.0.0[See changelog](https://docs.stackone.com/connectors/zuora/changelog.md)

[56 actions](#actions) · [9 events](#events) · 1 auth method

Billing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/zuora/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Requires an OAuth 2.0 client created by a Zuora administrator for each environment. The admin links the account and shar...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/zuora/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

56 actions

ActionDescription

List Accounts`zuora_list_accounts`

Retrieve a paginated list of all customer accounts via GET /v1/accounts. Note: Zuora does not provide a direct list acco...

Get Account`zuora_get_account`

Retrieve basic information about a customer account by account key via GET /v1/accounts/\{account-key}

Get Account Summary`zuora_get_account_summary`

Retrieve a comprehensive summary of a customer account including subscriptions, invoices, payments, and usage via GET /v...

Create Account`zuora_create_account`

Create a new customer account via POST /v1/accounts

Update Account`zuora_update_account`

Update an existing customer account via PUT /v1/accounts/\{account-key}

Delete Account`zuora_delete_account`

Delete a customer account via DELETE /v1/accounts/\{account-key}. This action is irreversible.

Get Contact`zuora_get_contact`

Retrieve details of a specific contact by ID via GET /v1/contacts/\{contactId}

Create Contact`zuora_create_contact`

Create a new contact via POST /v1/contacts

Update Contact`zuora_update_contact`

Update an existing contact via PUT /v1/contacts/\{contactId}

Delete Contact`zuora_delete_contact`

Delete a contact via DELETE /v1/contacts/\{contactId}. This action is irreversible.

List Products`zuora_list_products`

Retrieve a paginated list of all products from the product catalog via GET /v1/catalog/products

Get Product`zuora_get_product`

Retrieve a single product from the catalog by product ID or product number via GET /v1/catalog/products/\{product-key}

Create Product`zuora_create_product`

Create a new product via POST /v1/object/product

Update Product`zuora_update_product`

Update an existing product via PUT /v1/object/product/\{id}

Delete Product`zuora_delete_product`

Delete a product via DELETE /v1/object/product/\{id}

List Subscriptions`zuora_list_subscriptions`

Retrieve all subscriptions for a specific account via GET /v1/subscriptions/accounts/\{account-key}

Get Subscription`zuora_get_subscription`

Retrieve a specific subscription by subscription key via GET /v1/subscriptions/\{subscription-key}

Create Subscription`zuora_create_subscription`

Create a new subscription for an account via POST /v1/subscriptions

Update Subscription`zuora_update_subscription`

Update an existing subscription via PUT /v1/subscriptions/\{subscription-key}

Cancel Subscription`zuora_cancel_subscription`

Cancel an existing subscription via PUT /v1/subscriptions/\{subscription-key}/cancel

List Orders`zuora_list_orders`

Retrieve a paginated list of orders via GET /v1/orders

Get Order`zuora_get_order`

Retrieve a single order by order number via GET /v1/orders/\{orderNumber}

Create Order`zuora_create_order`

Create a new order via POST /v1/orders

Update Order`zuora_update_order`

Update an existing order via PUT /v1/orders/\{orderNumber}

Delete Order`zuora_delete_order`

Delete an order via DELETE /v1/orders/\{orderNumber}. This action is irreversible.

List Invoices`zuora_list_invoices`

Retrieve a paginated list of invoices for a specific account via GET /v1/billing-documents. Note: Zuora does not have a...

Get Invoice`zuora_get_invoice`

Retrieve a specific invoice by invoice key via GET /v1/invoices/\{invoiceKey}

Create Invoice`zuora_create_invoice`

Create a new invoice via POST /v1/invoices

Update Invoice`zuora_update_invoice`

Update an existing invoice via PUT /v1/invoices/\{invoiceKey}

Delete Invoice`zuora_delete_invoice`

Delete an invoice via DELETE /v1/invoices/\{invoiceKey}. This action is irreversible.

List Invoice Items`zuora_list_invoice_items`

Retrieve items for a specific invoice via GET /v1/invoices/\{invoiceKey}/items

List Payments`zuora_list_payments`

Retrieve a paginated list of payments via GET /v1/payments

Get Payment`zuora_get_payment`

Retrieve a single payment by key via GET /v1/payments/\{paymentKey}

Create Payment`zuora_create_payment`

Create a new payment via POST /v1/payments

Update Payment`zuora_update_payment`

Update a payment via PUT /v1/payments/\{paymentId}

Delete Payment`zuora_delete_payment`

Delete a payment via DELETE /v1/payments/\{paymentKey}. This action is irreversible.

Cancel Payment`zuora_cancel_payment`

Cancel a payment via PUT /v1/payments/\{paymentKey}/cancel

List Payment Methods`zuora_list_payment_methods`

List payment methods of an account via GET /v1/accounts/\{account-key}/payment-methods

Get Payment Method`zuora_get_payment_method`

Retrieve a payment method by ID via GET /v1/payment-methods/\{payment-method-id}

Update Payment Method`zuora_update_payment_method`

Update a payment method via PUT /v1/payment-methods/\{payment-method-id}

Delete Payment Method`zuora_delete_payment_method`

Delete a payment method via DELETE /v1/payment-methods/\{payment-method-id}. This action is irreversible.

List Credit Memos`zuora_list_credit_memos`

Retrieve a paginated list of credit memos via GET /v1/creditmemos

Get Credit Memo`zuora_get_credit_memo`

Retrieve a credit memo by key via GET /v1/creditmemos/\{creditMemoKey}

Create Credit Memo`zuora_create_credit_memo`

Create a credit memo from a charge via POST /v1/creditmemos

Update Credit Memo`zuora_update_credit_memo`

Update a credit memo via PUT /v1/creditmemos/\{creditMemoKey}

Delete Credit Memo`zuora_delete_credit_memo`

Delete a credit memo via DELETE /v1/creditmemos/\{creditMemoKey}. This action is irreversible.

List Debit Memos`zuora_list_debit_memos`

Retrieve a paginated list of debit memos via GET /v1/debitmemos

Get Debit Memo`zuora_get_debit_memo`

Retrieve a debit memo by key via GET /v1/debitmemos/\{debitMemoKey}

Create Debit Memo`zuora_create_debit_memo`

Create a debit memo from a charge via POST /v1/debitmemos

Update Debit Memo`zuora_update_debit_memo`

Update a debit memo via PUT /v1/debitmemos/\{debitMemoKey}

Delete Debit Memo`zuora_delete_debit_memo`

Delete a debit memo via DELETE /v1/debitmemos/\{debitMemoKey}. This action is irreversible.

List Refunds`zuora_list_refunds`

Retrieve a paginated list of refunds via GET /v1/refunds

Get Refund`zuora_get_refund`

Retrieve a refund by key via GET /v1/refunds/\{refundKey}

Update Refund`zuora_update_refund`

Update a refund via PUT /v1/refunds/\{refundId}

Delete Refund`zuora_delete_refund`

Delete a refund via DELETE /v1/refunds/\{refundKey}. This action is irreversible.

Cancel Refund`zuora_cancel_refund`

Cancel a refund via PUT /v1/refunds/\{refundKey}/cancel

## Events

Tags

Select all
|
Clear

Accounts

Invoices

Payments

Refunds

Subscriptions

Webhooks

No tags found

9 events

EventDescriptionTags

Account Created`zuora_webhook_account_created`

Emitted when a new customer account is created in Zuora

AccountsWebhooks

Account Updated`zuora_webhook_account_updated`

Emitted when a customer account is updated in Zuora

AccountsWebhooks

Subscription Created`zuora_webhook_subscription_created`

Emitted when a new subscription is created in Zuora

SubscriptionsWebhooks

Subscription Cancelled`zuora_webhook_subscription_cancelled`

Emitted when a subscription is cancelled in Zuora

SubscriptionsWebhooks

Subscription Renewed`zuora_webhook_subscription_renewed`

Emitted when a subscription is renewed in Zuora

SubscriptionsWebhooks

Invoice Posted`zuora_webhook_invoice_posted`

Emitted when an invoice is posted in Zuora

InvoicesWebhooks

Payment Processed`zuora_webhook_payment_processed`

Emitted when a payment is successfully processed in Zuora

PaymentsWebhooks

Payment Failed`zuora_webhook_payment_failed`

Emitted when a payment fails in Zuora

PaymentsWebhooks

Refund Processed`zuora_webhook_refund_processed`

Emitted when a refund is processed in Zuora

RefundsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.