Create a new Subscription

post

https://api.revenium.ai/profitstream/v2/api/subscriptions

Creates a new subscription for a product. Note: The product must have at least one data source (asset) configured.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Subscription configuration

A Subscription. Use subscriberEmail as the primary subscriber email field. The deprecated clientEmailAddress field remains accepted as an alias for compatibility.

name

string

required

The name of the subscription

owner

ownerId

string | null

required

The unique identifier of the subscription owner

client

subscriberEmail

string | null

The subscription subscriber email address. Required for create unless the deprecated clientEmailAddress alias is provided.

clientEmailAddress

string | null

deprecated

Deprecated alias for subscriberEmail.

organization

organizationId

string | null

The organization id (set to UNCLASSIFIED if null)

account

accountId

string | null

The account id

team

teamId

string | null

required

The unique identifier of the team that owns this subscription

product

productId

string | null

required

The product associated with the subscription

credentialIds

array of strings | null

The credential IDs associated with the product

credentialIds

expiration

string | null

The expiration of the subscription (ISO 8601 extended date-time format, e.g., 2024-09-01T00:00:00Z)

quotaNotificationThreshold

double

required

The percentage of quota consumption to exceed before sending a notification

notificationAddressesOnCreation

array of strings | null

Additional email addresses for ProductKey creation notification

notificationAddressesOnCreation

notificationAddressesOnQuotaThreshold

array of strings | null

Additional email addresses for ProductKey quota notifications

notificationAddressesOnQuotaThreshold

start

string | null

The subscription start date (ISO 8601 extended date-time format, e.g., 2024-09-01T00:00:00Z)

periodStart

string | null

Start date of current subscription period (ISO 8601 extended date-time format, e.g., 2024-09-01T00:00:00Z)

periodEnd

string | null

End date of current subscription period (ISO 8601 extended date-time format, e.g., 2024-09-01T00:00:00Z)

trialEnd

string | null

End date of subscription trial period (ISO 8601 extended date-time format, e.g., 2024-09-01T00:00:00Z)

namedSubscribers

array of strings | null

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

namedSubscribers

namedOrganizationIds

array of strings | null

The named organization IDs associated with this subscription

namedOrganizationIds

sendToSubscriber

boolean | null

Whether to send notifications to the subscriber

identityProvider

string | null

The name of the identity provider

additionalInvoiceRecipients

array of strings | null

Additional email addresses for invoice notifications

additionalInvoiceRecipients

charge

number | null

The recurring charge associated with this subscription

wentOverSubscriptionQuota

boolean | null

Went over subscription quota?

201Subscription created successfully

400Invalid input data

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found

409Conflict

422Unprocessable entity - Validation failed

429Too Many Requests