Authorization User Roles HTTP Methods Real-Time Data Streaming Status Codes Content Types Errors Pagination Rate Limiting Versioning
UNI-Cloud API 1.1
Overviewchevron_right
Endpointschevron_right
Please beware that the documentation is still in Alpha!
linkSubscriptions
To retrieve a subscription status, you can get a Subscription model.
1linkPOST https://billing.marxact.com/
2linkGET https://billing.marxact.com/v1/subscriptions/users/status
linkThe Subscription Model
Attributes
chevron_rightuserIdGUID
Unique identifier of the subject.subscriptionStatusSubscriptionStatus
The status of the subscriptionSubscriptionStatus
chevron_right- Active
The subscription is active.
- OnHold
The subscription is on-hold.
- AwaitingPayment
The subscription hasn't been paid yet.
- Active
1link{
2link "userId" : "a34996d8-72e1-4ea7-9bef-085e04e27a2f",
3link "subscriptionStatus" : "active"
4link}
1linkexport interface ISubscription {
2link userId: string;
3link subscriptionStatus: SubscriptionStatus;
4link}
5link
6linkexport enum SubscriptionStatus {
7link Active = 'active',
8link OnHold = 'on-hold',
9link AwaitingPayment = 'awaiting payment',
10link}
1linkpublic class ISubscription
2link{
3link Guid UserId { get; set; }
4link SubscriptionStatus subscriptionStatus { get; set; }
5link}
6link
7linkpublic enum SubscriptionStatus
8link{
9link Active,
10link OnHold,
11link AwaitingPayment
12link}
linkDEPRECATED GET Retrieve Subscription Statuses
Admin
Retrieves a list of all subscription statuses of the users under the Authenticated User's Tenant.
Parameters
chevron_right- No parameters.
Returns
chevron_rightReturns a list of all subscription statuses for all users under the user that was authenticated in the request.
get
1linkGET https://billing.marxact.com/v1/subscriptions/users/status HTTP/1.1
2linkAuthorization: Bearer {{token}}
response
1linkHTTP/1.1 200 Ok
2linkContent-Type: application/json
3link[
4link {
5link "userId" : "a34996d8-72e1-4ea7-9bef-085e04e27a2f",
6link "subscriptionStatus" : "active"
7link }
8link]