Introduction Ask Anything

payment-runs-{payment Run Id}

Delete payment run Get payment run summary

Get payment runs

v1-accounting-codes-{ac-id}

Delete accounting code Activate accounting code Deactivate accounting code

v1-accounting-codes

Get all accounting codes

v1-accounting-periods-{ap-id}

Delete accounting period Close accounting period Set accounting period to pending close Re-open accounting period Run trial balance

v1-accounting-periods

Get all accounting periods

v1-accounts-{account-key}

Get account Get account summary

Create account Generate billing documents by account

Amend Create Delete Execute Generate Query QueryMore Subscribe Update

Get amendments by subscription ID Get amendments by key

Add attachments Delete attachments View attachments list

v1-billing-preview-runs

Create Billing Preview Run Get Billing Preview Run

v1-bulk-{bulk-key}

Get mass action result Stop mass action

Perform mass action

v1-catalog/products

Get product catalog Multi-entity: Share a Product with an Entity

v1-charge-revenue-summaries

Get charge summary details by charge ID Get charge summary details by CRS number

v1-creditmemos-{credit Memo Id}-items

Get credit memo items Get credit memo item

v1-creditmemos-{credit Memo Id}-parts-{partid}-itemparts

Get credit memo part items Get credit memo part item

v1-creditmemos-{credit Memo Id}-parts-{partid}

Get credit memo part

v1-creditmemos-{credit Memo Id}-parts

Get credit memo parts

v1-creditmemos-{credit Memo Id}

Delete credit memo Apply credit memo Cancel credit memo Email credit memo Create credit memo PDF Post credit memo Create taxation items for credit memo Unapply credit memo

Get credit memos Get breakdown of credit memo by order Refund credit memo

v1-debitmemos-{debit Memo Id}-items

Get debit memo items Get debit memo item

v1-debitmemos-{debit Memo Id}

Delete debit memo Cancel debit memo Email debit memo Create debit memo PDF Post debit memo Create taxation items for debit memo

Get debit memos

v1-entities-{id}

Multi-entity: Delete entity Multi-entity: Provision entity

Multi-entity: Get entities

v1-entity-connections-{connection-id}

Multi-entity: Accept connection Multi-entity: Deny connection Multi-entity: Disconnect connection

v1-entity-connections

Multi-entity: Get connections

v1-invoices-{invoice Id}

Update invoice Create credit memo from invoice Create debit memo from invoice Email invoice Reverse invoice

Update invoices Get breakdown of invoice by order

v1-journal-entries-{je-number}

Delete summary journal entry Update basic information of a summary journal entry Cancel summary journal entry

v1-journal-entries

Create summary journal entry Get all summary journal entries in a journal run

v1-journal-runs-{jr-number}

Delete journal run Cancel journal run

v1-journal-runs

Create journal run

v1-notification-history

Get callout notification histories Get email notification histories

v1-object-account

CRUD: Create Account CRUD: Delete Account

v1-object-amendment

CRUD: Create amendment CRUD: Delete amendment

v1-object-bill-run

CRUD: Create Bill Run CRUD: Delete Bill Run

v1-object-contact

CRUD: Create Contact CRUD: Delete Contact

v1-object-export

CRUD: Create Export CRUD: Retrieve Export

v1-object-import

CRUD: Create Import CRUD: Retrieve Import

v1-object-invoice-adjustment

CRUD: Create InvoiceAdjustment CRUD: Delete InvoiceAdjustment

v1-object-invoice-payment

CRUD: Create InvoicePayment CRUD: Retrieve InvoicePayment

v1-object-payment

CRUD: Create payment CRUD: Delete payment

v1-object-payment-method

CRUD: Create payment method CRUD: Delete payment method

v1-object-product

CRUD: Create Product CRUD: Delete Product

v1-object-product-rate-plan

CRUD: Create ProductRatePlan CRUD: Delete ProductRatePlan

v1-object-refund

CRUD: Create refund CRUD: Delete refund

v1-object-taxation-item

CRUD: Create TaxationItem CRUD: Delete TaxationItem

v1-object-unit-of-measure

CRUD: Create UnitOfMeasure CRUD: Delete UnitOfMeasure

v1-object-usage

CRUD: Create Usage CRUD: Delete Usage

CRUD: Retrieve CommunicationProfile CRUD: Retrieve CreditBalanceAdjustment CRUD: Delete Feature CRUD: Delete InvoiceItemAdjustment CRUD: Retrieve InvoiceItem CRUD: Retrieve InvoiceSplitItem CRUD: Retrieve InvoiceSplit CRUD: Delete Invoice CRUD: Retrieve PaymentMethodSnapshot CRUD: Retrieve PaymentMethodTransactionLog CRUD: Get payment transaction log CRUD: Delete ProductFeature CRUD: Retrieve ProductRatePlanChargeTier CRUD: Delete ProductRatePlanCharge CRUD: Retrieve RatePlanChargeTier CRUD: Retrieve RatePlanCharge CRUD: Retrieve RatePlan CRUD: Retrieve RefundInvoicePayment CRUD: Retrieve RefundTransactionLog CRUD: Retrieve SubscriptionProductFeature CRUD: Delete Subscription

Create billing preview Invoice and collect

v1-orders-{order Number}

Delete order Get billing information for order Update order custom fields Get order metrics for evergreen subscription Get rated result for order

Get all orders Get orders by invoice owner Preview order Get orders by subscription number Get orders by subscription owner Get term information for subscription

v1-payment-methods-credit-cards

Create payment method Get payment methods Update payment method

v1-payment-methods-{payment-method-id}

Delete payment method Verify payment method

v1-payment-methods

Create payment method decryption

v1-payments-{payment Id}-parts-{partid}-itemparts

Get payment part items Get payment part item

v1-payments-{payment Id}-parts-{partid}

Get payment part

v1-payments-{payment Id}-parts

Get payment parts

v1-payments-{payment Id}

Delete payment Apply payment Cancel payment Refund payment Transfer payment Unapply payment

Get all payments

v1-refunds-{refund Id}-parts-{refundpartid}-itemparts

Get refund part items Get refund part item

v1-refunds-{refund Id}-parts-{refundpartid}

Get refund part

v1-refunds-{refund Id}-parts

Get refund parts

v1-refunds-{refund Id}

Delete refund Cancel refund

Get all refunds

v1-revenue-events

Get revenue events for a revenue schedule Get revenue event details

v1-revenue-items

Get revenue items by charge revenue summary number Get revenue items by revenue event number Get revenue items by revenue schedule

v1-revenue-recognition-rules

Get revenue recognition rule by product rate plan charge Get revenue recognition rule by subscription charge

v1-revenue-schedules-credit-memo-items/{cmi-id}

Get revenue schedule by credit memo item IDn Create revenue schedule for credit memo item (distribute by date range)n

v1-revenue-schedules-debit-memo-items/{dmi-id}

Get revenue schedule by debit memo item IDn Create revenue schedule for debit memo item (distribute by date range)n

v1-revenue-schedules-invoice-item-adjustments-{invoice-item-adj-key}

Create revenue schedule for Invoice Item Adjustment (manual distribution)Create revenue schedule for Invoice Item Adjustment (distribute by date range)

v1-revenue-schedules-invoice-item-adjustments

Get revenue schedule by invoice item adjustment

v1-revenue-schedules-invoice-items/{invoice-item-id}

Get revenue schedule by invoice item ID Create revenue schedule for Invoice Item (distribute by date range)

v1-revenue-schedules-{rs-number}

Delete revenue schedule Update revenue schedule basic information Distribute revenue across accounting periods Distribute revenue on specific date Distribute revenue by recognition start and end dates

v1-revenue-schedules

Get all revenue schedules of product charge by charge ID and billing account IDn Get revenue schedule by subscription charge

v1-rsa-signatures

Generate RSA signature Decrypt RSA signature

v1-subscriptions-{subscription-key}

Get subscriptions by key Cancel subscription Renew subscription Resume subscription Suspend subscription Get subscriptions by key and version

v1-subscriptions

Create subscription Get subscriptions by account Preview subscription Update subscription custom fields

v1-transactions

Get invoices Get payments

Post usage Get usage

v1-users/{username}

Multi-entity: Accept user access Multi-entity: Get entities that a user can access Multi-entity: Deny user access Multi-entity: Send user access requests

Email billing documents generated from bill run Get billing documents Establish connection to Zuora REST API service Get custom foreign currency exchange rates Describe object Get files Return HMAC signatures Return hosted pages Get payment gateways Generate quotes document Get the revenue automation start date Delete taxation item

Generate an OAuth token

Introduction Ask Anything

payment-runs-{payment Run Id}

Delete payment run Get payment run summary

Get payment runs

v1-accounting-codes-{ac-id}

Delete accounting code Activate accounting code Deactivate accounting code

v1-accounting-codes

Get all accounting codes

v1-accounting-periods-{ap-id}

Delete accounting period Close accounting period Set accounting period to pending close Re-open accounting period Run trial balance

v1-accounting-periods

Get all accounting periods

v1-accounts-{account-key}

Get account Get account summary

Create account Generate billing documents by account

Amend Create Delete Execute Generate Query QueryMore Subscribe Update

Get amendments by subscription ID Get amendments by key

Add attachments Delete attachments View attachments list

v1-billing-preview-runs

Create Billing Preview Run Get Billing Preview Run

v1-bulk-{bulk-key}

Get mass action result Stop mass action

Perform mass action

v1-catalog/products

Get product catalog Multi-entity: Share a Product with an Entity

v1-charge-revenue-summaries

Get charge summary details by charge ID Get charge summary details by CRS number

v1-creditmemos-{credit Memo Id}-items

Get credit memo items Get credit memo item

v1-creditmemos-{credit Memo Id}-parts-{partid}-itemparts

Get credit memo part items Get credit memo part item

v1-creditmemos-{credit Memo Id}-parts-{partid}

Get credit memo part

v1-creditmemos-{credit Memo Id}-parts

Get credit memo parts

v1-creditmemos-{credit Memo Id}

Delete credit memo Apply credit memo Cancel credit memo Email credit memo Create credit memo PDF Post credit memo Create taxation items for credit memo Unapply credit memo

Get credit memos Get breakdown of credit memo by order Refund credit memo

v1-debitmemos-{debit Memo Id}-items

Get debit memo items Get debit memo item

v1-debitmemos-{debit Memo Id}

Delete debit memo Cancel debit memo Email debit memo Create debit memo PDF Post debit memo Create taxation items for debit memo

Get debit memos

v1-entities-{id}

Multi-entity: Delete entity Multi-entity: Provision entity

Multi-entity: Get entities

v1-entity-connections-{connection-id}

Multi-entity: Accept connection Multi-entity: Deny connection Multi-entity: Disconnect connection

v1-entity-connections

Multi-entity: Get connections

v1-invoices-{invoice Id}

Update invoice Create credit memo from invoice Create debit memo from invoice Email invoice Reverse invoice

Update invoices Get breakdown of invoice by order

v1-journal-entries-{je-number}

Delete summary journal entry Update basic information of a summary journal entry Cancel summary journal entry

v1-journal-entries

Create summary journal entry Get all summary journal entries in a journal run

v1-journal-runs-{jr-number}

Delete journal run Cancel journal run

v1-journal-runs

Create journal run

v1-notification-history

Get callout notification histories Get email notification histories

v1-object-account

CRUD: Create Account CRUD: Delete Account

v1-object-amendment

CRUD: Create amendment CRUD: Delete amendment

v1-object-bill-run

CRUD: Create Bill Run CRUD: Delete Bill Run

v1-object-contact

CRUD: Create Contact CRUD: Delete Contact

v1-object-export

CRUD: Create Export CRUD: Retrieve Export

v1-object-import

CRUD: Create Import CRUD: Retrieve Import

v1-object-invoice-adjustment

CRUD: Create InvoiceAdjustment CRUD: Delete InvoiceAdjustment

v1-object-invoice-payment

CRUD: Create InvoicePayment CRUD: Retrieve InvoicePayment

v1-object-payment

CRUD: Create payment CRUD: Delete payment

v1-object-payment-method

CRUD: Create payment method CRUD: Delete payment method

v1-object-product

CRUD: Create Product CRUD: Delete Product

v1-object-product-rate-plan

CRUD: Create ProductRatePlan CRUD: Delete ProductRatePlan

v1-object-refund

CRUD: Create refund CRUD: Delete refund

v1-object-taxation-item

CRUD: Create TaxationItem CRUD: Delete TaxationItem

v1-object-unit-of-measure

CRUD: Create UnitOfMeasure CRUD: Delete UnitOfMeasure

v1-object-usage

CRUD: Create Usage CRUD: Delete Usage

CRUD: Retrieve CommunicationProfile CRUD: Retrieve CreditBalanceAdjustment CRUD: Delete Feature CRUD: Delete InvoiceItemAdjustment CRUD: Retrieve InvoiceItem CRUD: Retrieve InvoiceSplitItem CRUD: Retrieve InvoiceSplit CRUD: Delete Invoice CRUD: Retrieve PaymentMethodSnapshot CRUD: Retrieve PaymentMethodTransactionLog CRUD: Get payment transaction log CRUD: Delete ProductFeature CRUD: Retrieve ProductRatePlanChargeTier CRUD: Delete ProductRatePlanCharge CRUD: Retrieve RatePlanChargeTier CRUD: Retrieve RatePlanCharge CRUD: Retrieve RatePlan CRUD: Retrieve RefundInvoicePayment CRUD: Retrieve RefundTransactionLog CRUD: Retrieve SubscriptionProductFeature CRUD: Delete Subscription

Create billing preview Invoice and collect

v1-orders-{order Number}

Delete order Get billing information for order Update order custom fields Get order metrics for evergreen subscription Get rated result for order

Get all orders Get orders by invoice owner Preview order Get orders by subscription number Get orders by subscription owner Get term information for subscription

v1-payment-methods-credit-cards

Create payment method Get payment methods Update payment method

v1-payment-methods-{payment-method-id}

Delete payment method Verify payment method

v1-payment-methods

Create payment method decryption

v1-payments-{payment Id}-parts-{partid}-itemparts

Get payment part items Get payment part item

v1-payments-{payment Id}-parts-{partid}

Get payment part

v1-payments-{payment Id}-parts

Get payment parts

v1-payments-{payment Id}

Delete payment Apply payment Cancel payment Refund payment Transfer payment Unapply payment

Get all payments

v1-refunds-{refund Id}-parts-{refundpartid}-itemparts

Get refund part items Get refund part item

v1-refunds-{refund Id}-parts-{refundpartid}

Get refund part

v1-refunds-{refund Id}-parts

Get refund parts

v1-refunds-{refund Id}

Delete refund Cancel refund

Get all refunds

v1-revenue-events

Get revenue events for a revenue schedule Get revenue event details

v1-revenue-items

Get revenue items by charge revenue summary number Get revenue items by revenue event number Get revenue items by revenue schedule

v1-revenue-recognition-rules

Get revenue recognition rule by product rate plan charge Get revenue recognition rule by subscription charge

v1-revenue-schedules-credit-memo-items/{cmi-id}

Get revenue schedule by credit memo item IDn Create revenue schedule for credit memo item (distribute by date range)n

v1-revenue-schedules-debit-memo-items/{dmi-id}

Get revenue schedule by debit memo item IDn Create revenue schedule for debit memo item (distribute by date range)n

v1-revenue-schedules-invoice-item-adjustments-{invoice-item-adj-key}

Create revenue schedule for Invoice Item Adjustment (manual distribution)Create revenue schedule for Invoice Item Adjustment (distribute by date range)

v1-revenue-schedules-invoice-item-adjustments

Get revenue schedule by invoice item adjustment

v1-revenue-schedules-invoice-items/{invoice-item-id}

Get revenue schedule by invoice item ID Create revenue schedule for Invoice Item (distribute by date range)

v1-revenue-schedules-{rs-number}

Delete revenue schedule Update revenue schedule basic information Distribute revenue across accounting periods Distribute revenue on specific date Distribute revenue by recognition start and end dates

v1-revenue-schedules

Get all revenue schedules of product charge by charge ID and billing account IDn Get revenue schedule by subscription charge

v1-rsa-signatures

Generate RSA signature Decrypt RSA signature

v1-subscriptions-{subscription-key}

Get subscriptions by key Cancel subscription Renew subscription Resume subscription Suspend subscription Get subscriptions by key and version

v1-subscriptions

Create subscription Get subscriptions by account Preview subscription Update subscription custom fields

v1-transactions

Get invoices Get payments

Post usage Get usage

v1-users/{username}

Multi-entity: Accept user access Multi-entity: Get entities that a user can access Multi-entity: Deny user access Multi-entity: Send user access requests

Email billing documents generated from bill run Get billing documents Establish connection to Zuora REST API service Get custom foreign currency exchange rates Describe object Get files Return HMAC signatures Return hosted pages Get payment gateways Generate quotes document Get the revenue automation start date Delete taxation item

Generate an OAuth token

Home Zuora v1-objectCRUD: Retrieve CommunicationProfile

CRUD: Retrieve CommunicationProfile

GET {{baseUrl}}/v1/object/communication-profile/:id?fields=<>

Request Params

Key	Datatype	Required	Description
`fields`	string		Object fields to return

CRUD: Retrieve CreditBalanceAdjustment