Retrieve Summarized Product Key (Subscription) Events Associated with the Supplied Organization

get https://api.revenium.io/profitstream/v1/api/product-keys/events/summarized

Retrieve summarized product key (subscription) events associated with the supplied organization

Responses

Response body

object

content

array of objects

content

object

string

required

Unique identifier of the product key

valid

boolean

Is the key valid?

owner

string

required

The owner of the product key

client

string

required

In the event the owner doesn't have an account an email address can be passed to create the account on the fly

description

string

required

A description

organization

string

required

Name of the consuming organization

productIds

array of strings

required

The ids of the Products the ProductKey belongs to

productIds*

productNames

array of strings

required

The name of the Product the ProductKey belongs to

productNames*

productSettlementPeriods

array of strings

required

The name of the settlement periods for the associated Products

productSettlementPeriods*

assetIds

array of strings

required

The ids of the Assets the ProductKey belongs to

assetIds*

assetNames

array of strings

required

The names of the Asset the ProductKey belongs to

assetNames*

quotaConsumed

int64

required

The consumed quota associated with the product key

quota

int64

required

The optional transaction quota associated with the product key

subscriptionQuotaCount

int64

required

The subscriptionQuotaCount

subscriptionIncludedTransactions

int64

required

The subscriptionIncludedTransactions

key

string

required

The key

created

int64

required

The creation timestamp

deletionPending

boolean

required

Product key will be deleted soon, e.g. at the end of the current subscription period

subscriptionPeriodStartDate

int64

Start date of current subscription period

subscriptionPeriodEndDate

int64

End date of current subscription period

namedConsumers

array of strings

required

List of user email addresses who are allowed to access the product

namedConsumers*

namedOrganizationsIds

array of strings

required

The product's named organizations

namedOrganizationsIds*

domainAliases

array of strings

required

The list of domain aliases associated with the product key

domainAliases*

subscriptionAllowMidPeriodCancellation

boolean

Whether or not to allow mid period cancellation of the subscription with proration

notifyClientTrialAboutToExpire

boolean

Whether or not to notify client when trial is about to expiry

subscriptionTrialEndDate

int64

End date of subscription trial

currency

string

Currency of products in productKey

planQuotas

array of objects

required

A list of Plan Quotas for this Product Key

planQuotas*

object

string

required

The ID of the Plan

planTierId

string

required

The ID of the Plan Quota Tier

planTierName

string

required

The name of the Plan Quota Tier

tierQuotaConsumed

int64

Amount of tier Quota consumed

lowerTierQuotaLimit

int64

Lower Tier Quota Limit

tierQuota

int64

Tier Quota

wentOverTierQuota

boolean

True if tier quota has been exceeded

subscriptionTrialInProgress

boolean

Whether or not a subscription trial is in progress

subscriptionPreviouslyActivated

boolean

Whether or not a subscription has previously been active

subscriptionStatus

string

Status of Subscription

latestPaymentStatus

string

Status of Latest Payment

expirationDate

int64

Expiration Date

tags

array of strings

required

Tags associated with the product key

tags*

paymentConfigurations

array of strings

required

Payment configuration ids associated with the product key

paymentConfigurations*

paymentConfigurationName

string

required

Product Payment configuration name associated with the product key

paymentConfigurationProvider

string

required

Product Payment configuration provider associated with the product key

name

string

Name of product Ket

paymentSource

string

The product payment source

futureSubscriptionStartDate

int64

delay future subscriotion start date

pageable

object

offset

int64

sort

object

pageSize

int32

pageNumber

int32

unpaged

boolean

paged

boolean

last

boolean

totalElements

int64

totalPages

int32

first

boolean

size

int32

number

int32

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

numberOfElements

int32

empty

boolean

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.revenium.io/profitstream/v1/api/product-keys/events/summarized \
3
     --header 'accept: MediaType.APPLICATION_JSON_VALUE'

Click Try It! to start a request and see the response here! Or choose an example:

MediaType.APPLICATION_JSON_VALUE

application/json

text/plain

200The summarized product key events

403Forbidden to access this organization

404Organization not found