Zuora::ActionsApi

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

Method	HTTP request	Description
action_pos_tamend	POST /v1/action/amend	Amend
action_pos_tcreate	POST /v1/action/create	Create
action_pos_tdelete	POST /v1/action/delete	Delete
action_pos_texecute	POST /v1/action/execute	Execute
action_pos_tgenerate	POST /v1/action/generate	Generate
action_pos_tquery	POST /v1/action/query	Query
action_pos_tquery_more	POST /v1/action/queryMore	QueryMore
action_pos_tsubscribe	POST /v1/action/subscribe	Subscribe
action_pos_tupdate	POST /v1/action/update	Update

action_pos_tamend

ProxyActionamendResponse action_pos_tamend(amend_request, opts)

Amend

Use the amend call to change a subscription, such as upgrading the subscription. ## Notes * This feature is unavailable if you have the Orders feature enabled. See Orders Migration Guidance for more information. * If you do not have the Orders feature enabled, Zuora recommends that you use Update subscription to amend subscriptions. The amend call: * Supports the Amendment object * Is not an asynchronous process ## Limits ### Objects per Call Up to ten Amendment objects. ### Errors If one of your Amendment objects fails in a single amend call, then the entire call fails. ## Required Fields The following fields are always required for this call: * Amendment.Type * Amendment.Name * Amendment.SubscriptionId

Example

# load the gem
require 'zuora'

api_instance = Zuora::ActionsApi.new

amend_request = Zuora::ProxyActionamendRequest.new # ProxyActionamendRequest | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | 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) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Amend
  result = api_instance.action_pos_tamend(amend_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ActionsApi->action_pos_tamend: #{e}"
end

Parameters

Name	Type	Description	Notes
amend_request	ProxyActionamendRequest
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

ProxyActionamendResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

action_pos_tcreate

ProxyActioncreateResponse action_pos_tcreate(create_request, opts)

Create

Use the create call to create one or more objects of a specific type. You can specify different types in different create calls, but each create call must apply to only one type of object. ## Limits ### Objects per Call 50 objects are supported in a single call. ## How to Use this Call You can call create on an array of one or more zObjects. It returns an array of SaveResults, indicating the success or failure of creating each object. The following information applies to this call: * You cannot pass in null zObjects. * You can pass in a maximum of 50 zObjects at a time. * All objects must be of the same type. ### Using Create and Subscribe Calls Both the create and subscribe calls will create a new account. However, there are differences between the calls. Use the create call to create an account independent of a subscription. Use the subscribe call to create the account with the subscription and the initial payment information.

Example

# load the gem
require 'zuora'

api_instance = Zuora::ActionsApi.new

create_request = Zuora::ProxyActioncreateRequest.new # ProxyActioncreateRequest | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | 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) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Create
  result = api_instance.action_pos_tcreate(create_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ActionsApi->action_pos_tcreate: #{e}"
end

Parameters

Name	Type	Description	Notes
create_request	ProxyActioncreateRequest
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

ProxyActioncreateResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

action_pos_tdelete

ProxyActiondeleteResponse action_pos_tdelete(delete_request, opts)

Delete

Deletes one or more objects of the same type. You can specify different types in different delete calls, but each delete call must apply only to one type of object. The following information applies to this call: * You will need to first determine the IDs for the objects you wish to delete. * You cannot pass in any null IDs. * All objects in a specific delete call must be of the same type. ### Objects per Call 50 objects are supported in a single call.

Example

# load the gem
require 'zuora'

api_instance = Zuora::ActionsApi.new

delete_request = Zuora::ProxyActiondeleteRequest.new # ProxyActiondeleteRequest | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | 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) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Delete
  result = api_instance.action_pos_tdelete(delete_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ActionsApi->action_pos_tdelete: #{e}"
end

Parameters

Name	Type	Description	Notes
delete_request	ProxyActiondeleteRequest
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

ProxyActiondeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

action_pos_texecute

ProxyActionexecuteResponse action_pos_texecute(execute_request, opts)

Execute

Use the execute call to execute a process to split an invoice into multiple invoices. The original invoice must be in draft status. The resulting invoices are called split invoices. Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. To split a draft invoice into multiple split invoices: 1. Use the create call to create a separate InvoiceSplitItem object for each split invoice that you want to create from the original draft invoice. 2. Use the create call to create a single InvoiceSplit object to collect all of the InvoiceSplitItem objects. 3. Use the execute call to split the draft invoice into multiple split invoices. You need to create InvoiceSplitItem objects and an InvoiceSplit object before you can use the execute call. * Supported objects: InvoiceSplit * Asynchronous process: yes

Example

# load the gem
require 'zuora'

api_instance = Zuora::ActionsApi.new

execute_request = Zuora::ProxyActionexecuteRequest.new # ProxyActionexecuteRequest | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | 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) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Execute
  result = api_instance.action_pos_texecute(execute_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ActionsApi->action_pos_texecute: #{e}"
end

Parameters

Name	Type	Description	Notes
execute_request	ProxyActionexecuteRequest
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

ProxyActionexecuteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

action_pos_tgenerate

ProxyActiongenerateResponse action_pos_tgenerate(generate_request, opts)

Generate

Generates an on-demand invoice for a specific customer. This is similar to creating an ad-hoc bill run for a specific customer account in the Zuora UI. * Supported objects: Invoice * Asynchronous process: yes The ID of the generated invoice is returned in the response. If multiple invoices are generated, only the id of the first invoice generated is returned. This occurs when an account has multiple subscriptions with the invoice subscription separately option enabled.

Example

# load the gem
require 'zuora'

api_instance = Zuora::ActionsApi.new

generate_request = Zuora::ProxyActiongenerateRequest.new # ProxyActiongenerateRequest | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | 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) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Generate
  result = api_instance.action_pos_tgenerate(generate_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ActionsApi->action_pos_tgenerate: #{e}"
end

Parameters

Name	Type	Description	Notes
generate_request	ProxyActiongenerateRequest
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

ProxyActiongenerateResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

action_pos_tquery

ProxyActionqueryResponse action_pos_tquery(query_request, opts)

Query

The query call sends a query expression by specifying the object to query, the fields to retrieve from that object, and any filters to determine whether a given object should be queried. You can use ZOQL (Zuora Object Query Language) to construct those queries, passing them through the queryString. Once the call is made, the API executes the query against the specified object and returns a query response object to your application. Your application can then iterate through rows in the query response to retrieve information. ## Limitations This call has the following limitations: * All ZOQL keywords must be in lower case. * The number of records returned is limited to 2000 records

Example

# load the gem
require 'zuora'

api_instance = Zuora::ActionsApi.new

query_request = Zuora::ProxyActionqueryRequest.new # ProxyActionqueryRequest | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | 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) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Query
  result = api_instance.action_pos_tquery(query_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ActionsApi->action_pos_tquery: #{e}"
end

Parameters

Name	Type	Description	Notes
query_request	ProxyActionqueryRequest
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

ProxyActionqueryResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

action_pos_tquery_more

ProxyActionqueryMoreResponse action_pos_tquery_more(query_more_request, opts)

QueryMore

Use queryMore to request additional results from a previous query call. If your initial query call returns more than 2000 results, you can use queryMore to query for the additional results. Any queryLocator results greater than 2,000, will only be stored by Zuora for 5 days before it is deleted. This call sends a request for additional results from an initial query call. If the initial query call returns more than 2000 results, you can use the queryLocator returned from query to request the next set of results. Note: Zuora expires queryMore cursors after 15 minutes of activity. To use queryMore, you first construct a query call. By default, the query call will return up to 2000 results. If there are more than 2000 results, query will return a boolean done, which will be marked as false, and a queryLocator, which is a marker you will pass to queryMore to get the next set of results.

Example

# load the gem
require 'zuora'

api_instance = Zuora::ActionsApi.new

query_more_request = Zuora::ProxyActionqueryMoreRequest.new # ProxyActionqueryMoreRequest | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | 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) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #QueryMore
  result = api_instance.action_pos_tquery_more(query_more_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ActionsApi->action_pos_tquery_more: #{e}"
end

Parameters

Name	Type	Description	Notes
query_more_request	ProxyActionqueryMoreRequest
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

ProxyActionqueryMoreResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

action_pos_tsubscribe

ProxyActionsubscribeResponse action_pos_tsubscribe(subscribe_request, opts)

Subscribe

This call performs many actions. Use the subscribe call to bundle information required to create at least one new subscription. Note: This feature is unavailable if you have the Orders feature enabled. See Orders Migration Guidance for more information. The call takes in an array of SubscribeRequests. Because it takes an array, you can submit a batch of subscription requests at once. You can create up to 50 different subscriptions in a single subscribe call. This is a combined call that you can use to perform all of the following tasks in a single call: * Create accounts * Create contacts * Create payment methods, including external payment options * Create an invoice for the subscription * Apply the first payment to a subscription ## Object Limits 50 objects are supported in a single call. ## Effective Date If the effective date is in the future, the invoices will not be generated, and there will be no invoice number. ## Subscription Name, Number, and ID ### Subscription Name and Number The subscription name is a unique identifier for the subscription. If you do not specify a value for the name, Zuora will create one automatically. The automatically generated value is known as the subscription number, such as A-S00000080. You cannot change the subscription name or number after creating the subscription. * Subscription name: The name that you set for the subscription. * Subscription number: The value generated by Zuora automatically if you do not specify a subscription name. Both the subscription name and number must be unique. If they are not, an error will occur. ### Subscription ID The subscription ID is a 32-digit ID in the format 4028xxxx. This is also the unique identifier for a subscription. This value is automatically generated by the system and cannot be edited or updated, but it can be queried. One subscription can have only one subscription name or number, but it can have multiple IDs: Each version of a subscription has a different ID. The Subscription object contains the fields OriginalId and PreviousSubscriptionId. OriginalId is the ID for the first version of a subscription. PreviousSubscriptionId is the ID of the version created immediately prior to the current version. ## Subscription Preview You can preview invoices that would be generated by the subscribe call. ## Invoice Subscriptions Separately If you have enabled the invoice subscriptions separately feature, a subscribe call will generate an invoice for each subscription for every subscription where the field IsInvoiceSeparate is set to true. If the invoice subscriptions separately feature is disabled, a subscribe call will generate a single invoice for all subscriptions. See Invoicing Subscriptions Separately for more information. ## Subscriptions and Draft Invoices If a draft invoice that includes charges exists in a customer account, using the subscribe call to create a new subscription and generate an invoice will cause the new subscription to be added to the existing draft invoice. Zuora will then post the invoice. ## When to Use Subscribe and Create Calls You can use either the subscribe call or the create call to create the objects associated with a subscription (accounts, contacts, and so on). There are differences between these calls, however, and some situations are better for one or the other. ### Use the Subscribe Call The subscribe call bundles up all the information you need for a subscription. Use the subscribe call to create new subscriptions when you have all the information you need. Subscribe calls cannot update BillTo, SoldTo, and Payment information objects cannot be updated if there is an existing account ID in the call. These objects are not supported in a subscribe call. ### Use the Create Call The create call is more useful when you want to develop in stages. For example, if you want to first create an account, then a contact, and so on. If you do not have all information available, use the create call. To create a subscription, you must activate the account from Draft status to Active by calling the subscribe call.

Example

# load the gem
require 'zuora'

api_instance = Zuora::ActionsApi.new

subscribe_request = Zuora::ProxyActionsubscribeRequest.new # ProxyActionsubscribeRequest | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | 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) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Subscribe
  result = api_instance.action_pos_tsubscribe(subscribe_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ActionsApi->action_pos_tsubscribe: #{e}"
end

Parameters

Name	Type	Description	Notes
subscribe_request	ProxyActionsubscribeRequest
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

ProxyActionsubscribeResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

action_pos_tupdate

ProxyActionupdateResponse action_pos_tupdate(update_request, opts)

Update

Updates the information in one or more objects of the same type. You can specify different types of objects in different update calls, but each specific update call must apply to only one type of object. You can update an array of one or more zObjects. It returns an array of SaveResults, indicating the success or failure of updating each object. The following information applies to this call: * You cannot pass in null zObjects. * You can pass in a maximum of 50 zObjects at a time. * All objects must be of the same type. * For each field in each object, you must determine that object's ID. Then populate the fields that you want update with the new information. * Zuora ignores unrecognized fields in update calls. For example, if an optional field is spelled incorrectly or a field that does not exist is specified, Zuora ignores the field and continues to process the call. No error message is returned for unrecognized fields. ## Object Limits 50 objects are supported in a single call.

Example

# load the gem
require 'zuora'

api_instance = Zuora::ActionsApi.new

update_request = Zuora::ProxyActionupdateRequest.new # ProxyActionupdateRequest | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | 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) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Update
  result = api_instance.action_pos_tupdate(update_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ActionsApi->action_pos_tupdate: #{e}"
end

Parameters

Name	Type	Description	Notes
update_request	ProxyActionupdateRequest
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

ProxyActionupdateResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

Files

ActionsApi.md

Latest commit

History

ActionsApi.md

File metadata and controls

Zuora::ActionsApi

action_pos_tamend

Example

Parameters

Return type

Authorization

HTTP request headers

action_pos_tcreate

Example

Parameters

Return type

Authorization

HTTP request headers

action_pos_tdelete

Example

Parameters

Return type

Authorization

HTTP request headers

action_pos_texecute

Example

Parameters

Return type

Authorization

HTTP request headers

action_pos_tgenerate

Example

Parameters

Return type

Authorization

HTTP request headers

action_pos_tquery

Example

Parameters

Return type

Authorization

HTTP request headers

action_pos_tquery_more

Example

Parameters

Return type

Authorization

HTTP request headers

action_pos_tsubscribe

Example

Parameters

Return type

Authorization

HTTP request headers

action_pos_tupdate

Example

Parameters

Return type

Authorization

HTTP request headers