Actions

56 actions

Action

Description

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

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

Get Account Summary

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

Create Account

Create a new customer account via POST /v1/accounts

Update Account

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

Delete Account

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

Get Contact

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

Create Contact

Create a new contact via POST /v1/contacts

Update Contact

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

Delete Contact

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

List Products

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

Get Product

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

Create Product

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

Update Product

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

Delete Product

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

List Subscriptions

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

Get Subscription

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

Create Subscription

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

Update Subscription

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

Cancel Subscription

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

List Orders

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

Get Order

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

Create Order

Create a new order via POST /v1/orders

Update Order

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

Delete Order

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

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

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

Create Invoice

Create a new invoice via POST /v1/invoices

Update Invoice

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

Delete Invoice

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

List Invoice Items

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

List Payments

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

Get Payment

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

Create Payment

Create a new payment via POST /v1/payments

Update Payment

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

Delete Payment

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

Cancel Payment

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

List Payment Methods

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

Get Payment Method

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

Update Payment Method

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

Delete Payment Method

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

List Credit Memos

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

Get Credit Memo

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

Create Credit Memo

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

Update Credit Memo

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

Delete Credit Memo

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

List Debit Memos

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

Get Debit Memo

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

Create Debit Memo

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

Update Debit Memo

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

Delete Debit Memo

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

List Refunds

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

Get Refund

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

Update Refund

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

Delete Refund

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

Cancel Refund

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