API Reference
Log In
API Reference

Create a new Subscription

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

Creates a subscription that gives one subscriber access to one product. The product must have at least one data source configured. Add the query parameter includeRelatedResources=true to also create a credential for the new subscription. The response then carries the credential's full externalId in provisionedCredentialExternalId, and this is the only time it is shown in full.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Subscription configuration

A subscription gives one subscriber access to one product and its pricing plan. Use subscriberEmail to name the subscriber. The older clientEmailAddress field is still accepted as an alias.

string
required

The name of the subscription

owner
string | null
required

The ID of the user in your account who owns this subscription

client
string | null

The subscriber's email address. Required when you create a subscription, unless you send the older clientEmailAddress alias instead.

string | null
deprecated

Deprecated alias for subscriberEmail.

organization
string | null

The ID of the customer organization this subscription belongs to. If you leave it out, the subscription is filed under your team's Unclassified organization.

account
string | null

The ID of a billing account to link to this subscription. Optional.

team
string | null
required

The ID of the team that owns this subscription

product
string | null
required

The ID of the product this subscription gives access to

credentialIds
array of strings | null

The IDs of existing credentials to link to this subscription

credentialIds
string | null

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

notificationAddressesOnCreation
array of strings | null

Extra email addresses that are notified when the subscription is created

notificationAddressesOnCreation
notificationAddressesOnQuotaThreshold
array of strings | null

Extra email addresses that are notified when the quota notification threshold is reached

notificationAddressesOnQuotaThreshold
string | null

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

string | null

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

string | null

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

string | null

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

namedSubscribers
array of strings | null

Email addresses of other users who may use this subscription

namedSubscribers
namedOrganizationIds
array of strings | null

The IDs of other customer organizations allowed to use this subscription

namedOrganizationIds
boolean | null

Whether the subscriber is emailed when the subscription is created

string | null

Not used. The value is accepted and ignored.

additionalInvoiceRecipients
array of strings | null

Extra email addresses that receive this subscription's invoices

additionalInvoiceRecipients
number | null

The recurring charge for each billing period, from the product's pricing plan, in the plan's currency

boolean | null

True when usage has gone over the subscription's quota

tags
array of strings | null

Tags associated with the subscription

tags
string | null

The ID of the quote for this subscription in your quoting (CPQ) or finance system. Optional.

boolean | null

Whether the subscription may be cancelled in the middle of a billing period

double | null

The share of a tier quota that must be used before a quota notification is sent, as a fraction from 0 to 1. For example 0.8 means 80%. 0 means no notification. Send this field to set the threshold. On create, leaving it out uses the product's tierQuotaNotificationThreshold. On update, leaving it out keeps the current value.

string | null

An external ID for this subscription, for example its ID in your billing system. Optional.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 4 months ago

Did this page help you?