Child pages
  • Admin API Method listProductPurchases

This documentation is for a previous version of Flexiant Cloud Orchestrator. The most recent version is v5.0. For the most recent documentation please see here

Skip to end of metadata
Go to start of metadata

Description
This function searches for a list of product purchases matching a given search filter.
Style
Document
Input (Literal)
The input of this method is the argument listProductPurchases of type listProductPurchases having the structure defined by the following table.

Element

Type

Occurs

Description

searchFilter

searchFilter

0..1

The filter to apply

queryLimit

queryLimit

0..1

The query limit to apply

Output (Literal)
The output of this method is the argument listProductPurchasesResponse of type listProductPurchasesResponse having the structure defined by the following table.

Element

Type

Occurs

Description

listProductPurchases

listResult

0..1

The list of matching product purchases

Remarks
On an exception, no product purchases are returned.
The product purchases searched for are specified by the searchFilter and the queryLimit specified by the caller. For documentation on how the filter and query limit work, see the complex types searchFilter and queryLimit.
Each product purchase represents an instance of a customer subscribing to a product offer, potentially generating a stream of one or more unit transactions associated therewith. For more details, see the productPurchase complex type.

  • No labels