Update a Subscription

put

https://api.revenium.ai/profitstream/v2/api/subscriptions/{id}

Update a subscription

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Unique identifier of the subscription to update. Format: Revenium hashid (URL-safe encoded string).

Body Params

name

string

required

The name of the subscription

ownerId

string

required

The unique identifier of the subscription owner

clientEmailAddress

string

required

The subscription client email address

organizationId

string

The organization id (set to UNCLASSIFIED if null)

accountId

string

The account id

teamId

string

required

The unique identifier of the team that owns this subscription

productId

string

required

The product associated with the subscription

credentialIds

array of strings

The credential IDs associated with the product

credentialIds

expiration

string

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

Additional email addresses for ProductKey creation notification

notificationAddressesOnCreation

notificationAddressesOnQuotaThreshold

array of strings

Additional email addresses for ProductKey quota notifications

notificationAddressesOnQuotaThreshold

start

string

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

periodStart

string

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

periodEnd

string

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

trialEnd

string

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

namedSubscribers

array of strings

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

namedSubscribers

namedOrganizationIds

array of strings

The named organization IDs associated with this subscription

namedOrganizationIds

sendToSubscriber

boolean

Whether to send notifications to the subscriber

identityProvider

string

The name of the identity provider

additionalInvoiceRecipients

array of strings

Additional email addresses for invoice notifications

additionalInvoiceRecipients

charge

number

The recurring charge associated with this subscription

wentOverSubscriptionQuota

boolean

Went over subscription quota?

200The subscription

400Invalid request

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Subscription not found

409Conflict - Resource conflict

422Unprocessable entity - Validation failed

500Internal server error