superadmin can list invoices being available to any company existing in Rainbow. bp_finance can only list invoices available to their BP company. bp_finance and organization_admin can list invoices available for all the companies being in their organization. DR and BP VAD companies have invoices in Zuora. An error is returned when trying to list invoices for companies which are not BP DR or BP VAD. superadmin can list invoices being available to any company existing in Rainbow. bp_finance can only list invoices available to their BP company. bp_finance and organization_admin can list invoices available for all the companies being in their organization. DR and BP VAD companies have invoices in Zuora. An error is returned when trying to list invoices for companies which are not BP DR or BP VAD. This API retrieves an invoice file available on Zuora. The file is in PDF format.
superadmin can get invoice files belonging to any company existing in Rainbow.
bp_finance can only get invoice files for their BP company.
Users being both bp_finance and organization_admin can get invoice files for all the companies being in their organization.
fileId to provide comes from the response of API GET /api/rainbow/subscription/v1.0/companies/:companyId/invoices (field invoicesFiles.id).
Get an offer from its id
The requested offer must be in the requested company's assigned catalog, otherwise an error 403 is returned.
Get an offer from its id
The requested offer must be in the requested company's assigned catalog, otherwise an error 403 is returned.
superadmin and support can list offers being available to any company existing in Rainbow. business_admin can list only demo offers being available to any company existing in Rainbow. bp_admin can only list offers available to their own company and offers available to End Customer / BP IR companies for which the BP company is bp_admin's one. bp_finance can only list offers available to their own company and offers available to End Customer / BP IR companies for which the BP company is bp_finance's one. organization_admin can only list offers available for all the companies being in their organisation. company_admin can only list offers available to their own company. bp_admin or bp_finance and organization_admin can list offers available for all the companies being in their organization and the End Customers / BP IR being linked to BP companies of the organisation. canBeSold set to true. superadmin and support can list offers being available to any company existing in Rainbow. business_admin can list only demo offers being available to any company existing in Rainbow. bp_admin can only list offers available to their own company and offers available to End Customer / BP IR companies for which the BP company is bp_admin's one. bp_finance can only list offers available to their own company and offers available to End Customer / BP IR companies for which the BP company is bp_finance's one. organization_admin can only list offers available for all the companies being in their organisation. company_admin can only list offers available to their own company. bp_admin or bp_finance and organization_admin can list offers available for all the companies being in their organization and the End Customers / BP IR being linked to BP companies of the organisation. canBeSold set to true. superadmin can create quotation for any company existing in Rainbow. bp_finance can only create quotation for their own company and for End Customer / BP IR companies for which the BP company is bp_finance's one. bp_finance and organization_admin can create quotation for all the companies being in their organization and the End Customers / BP IR being linked to BP companies of the organisation. superadmin and bp_finance can create quotation (for now at least), users with admin role alone are denied. nb_users or flat_fee or nb_services can be quoted. resell businessModel, his bpApplicantNumber must exist in Business Store (i.e. API GET /api/rainbow/subscription/v1.0/companies/check-applicant-number/{bpApplicantNumber} must return true). offerId parameter have to be used. subscriptionId parameter have to be used. superadmin can create quotation for any company existing in Rainbow. bp_finance can only create quotation for their own company and for End Customer / BP IR companies for which the BP company is bp_finance's one. bp_finance and organization_admin can create quotation for all the companies being in their organization and the End Customers / BP IR being linked to BP companies of the organisation. superadmin and bp_finance can create quotation (for now at least), users with admin role alone are denied. nb_users or flat_fee or nb_services can be quoted. resell businessModel, his bpApplicantNumber must exist in Business Store (i.e. API GET /api/rainbow/subscription/v1.0/companies/check-applicant-number/{bpApplicantNumber} must return true). offerId parameter have to be used. subscriptionId parameter have to be used. This API can be used to upload pre paid offers from ACTIS file, to set in the given company subscriptions.
Rules:
The API only returns status code > 200 if the requested companyId (from URL) is not a BP company or if the provided file couldn't be parsed (wrong format, XML without the expected structure).
Otherwise, the API returns with a status code 200 and the following data are returned:
Please note that creation steps will NOT BE EXECUTED if parameter 'preview=true' is set.
This mode is used to check the validity of a given ACTIS file, and to show all the actions that should be performed in standard mode ('preview' not set or set to false).
This API can be used to upload pre paid offers from ACTIS file, to set in the given company subscriptions.
Rules:
The API only returns status code > 200 if the requested companyId (from URL) is not a BP company or if the provided file couldn't be parsed (wrong format, XML without the expected structure).
Otherwise, the API returns with a status code 200 and the following data are returned:
Please note that creation steps will NOT BE EXECUTED if parameter 'preview=true' is set.
This mode is used to check the validity of a given ACTIS file, and to show all the actions that should be performed in standard mode ('preview' not set or set to false).
This API can be used to upload pre paid offers from ACTIS file, to set in the given company subscriptions.
Rules:
The API only returns status code > 200 if the requested companyId (from URL) is not a BP company or if the provided file couldn't be parsed (wrong format, XML without the expected structure).
Otherwise, the API returns with a status code 200 and the following data are returned:
Please note that creation steps will NOT BE EXECUTED if parameter 'preview=true' is set.
This mode is used to check the validity of a given ACTIS file, and to show all the actions that should be performed in standard mode ('preview' not set or set to false).
/!\\ For now, only resell model is managed (i.e. a bp_finance of BP VAD/IR/DR buy a subscription for one of his customer companies (EC) or bp_finance of BP VAD buy a subscription for one of his BP IR).
This API can be used to create a subscription for a company to a given offer.
If BP company have resell businessModel, his bpApplicantNumber must exist in Business Store (i.e. API GET /api/rainbow/subscription/v1.0/companies/check-applicant-number/{bpApplicantNumber} must return true).
Note: BP IR companies should not have a bpApplicantNumber, as they don't pay directly ALE (their BP VAD does).
superadmin can create subscriptions for every company. superadmin can create subscription even for offers which can't be sold (not paid offers, like beta, Enterprise Demo, ...).
business_admin can create subscriptions for every company. business_admin can create subscription only for demo offers. If business_admin tries to subscribe to an offer that is not a demo offer, request is rejected with a 400 bad request error.
bp_finance can only create subscriptions for End Customer companies / BP IR companies for which bp_finance's company is the BP company.
Users being both bp_finance and organization_admin can create subscription for all the companies being in their organization and the End Customers / BP IR being linked to BP companies of the organisation.
Only superadmin and bp_finance can create subscriptions (for now at least), users with admin role alone are denied.
bp_finance of BP IR companies can only create subscriptions for End Customer companies / their own BP IR companies to pre-paid offers, and only if their VAD have set the fieldadminHasRightToUpdateSubscriptions to true for this BP IR company.
Creating a subscription corresponds to a company buying a paid offer. Therefore, a subscription links a company to an offer.
The list of offers which can be bought can be listed using API GET /api/rainbow/subscription/v1.0/companies/:companyId/offers (warning: the offers already bought are also listed).
The offer has to be in the catalog assigned to the BP company, otherwise an error 403 is returned (except if subscription creation is done by superadmin).
The offers have a businessModel corresponding to the way they are sold.
nb_users or nb_services correspond to offers sold for a given number of users (licences). maxNumberUsers.nb_users or nb_services, maxNumberUsers must be provided (it must be > 0).maxNumberUsers corresponds to the maximum number of users who can be assigned to the subscription of this offer.nb_users or nb_services, a quotation can be made using API POST /api/rainbow/subscription/v1.0/companies/:companyId/quotations.nb_services, the company subscription can be assigned to as many users as available licences (field maxNumberUsers of subscription objects) using API POST /api/rainbow/admin/v1.0/users/{userId}/profiles/subscriptions/{subscriptionId}.usage correspond to offers for which billing will be done according to customer consumption (minutes of conference, TB of storage, ...). usage (as the invoice will depend of customer consumption)<message id=\"8413b42e-563c-4437-9a53-06f638b5ab69_0\" type=\"management\" from=\"pcloud_subscription_1@openrainbow.com/172440802160413612281463752830017532\" to=\"5abb735b2d3c4e50adde276c50ec489c@@openrainbow.com\" xmlns=\"jabber:client\"> <companysubscription xmlns=\"jabber:iq:configuration\" subscriptionId=\"5808afeb4372eb19547e90cf\" companyId=\"58bd63d5dc5ef5eb3fe154c0\" action=\"create\"> <offerId>58072f646237427a3687dc90</offerId> <offerName>Enterprise</offerName> <profileId>57cd90ddc04fd92e232ae258</profileId> <profileName>Enterprise</profileName> <status>creating</status> <syncOngoing>true</syncOngoing> <maxNumberUsers>50</maxNumberUsers> </companysubscription> </message>status field with value creating and the syncOngoing flag indicates that the creation is ongoing on Business Store and Zuora side. status equal to active and syncOngoing equal to false. provisioningOngoing in provisioningNeeded array indicates the status of the creation on PGI/JANUS."
},
"response": [
{
"name": "Success-Response:",
"originalRequest": {
"method": "POST",
"url": {
"raw": "{{SubscriptionPortalServer}}/api/rainbow/subscription/v1.0/companies/:companyId/subscriptions",
"host": [
"{{SubscriptionPortalServer}}"
],
"path": [
"api",
"rainbow",
"subscription",
"v1.0",
"companies",
":companyId",
"subscriptions"
],
"variable": [
{
"key": "companyId",
"description": "Company unique identifier (like 569ce8c8f9336c471b98eda1)"
}
]
},
"header": [
{
"key": "accept",
"name": "accept",
"value": "application/json",
"description": "application/json",
"type": "text",
"disabled": false
},
{
"key": "content-type",
"name": "content-type",
"value": "application/json",
"description": "application/json",
"type": "text",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"offerId\": \"58072f646237427a3687dc90\",\n \"maxNumberUsers\": 50,\n \"autoRenew\": false,\n \"purchaseOrderNumber\": \"my po\",\n \"renewalTerm\":42\n}"
},
"description": "Required role(s): `business_admin`, `bp_finance`, `organization_admin`\n\n/!\\ For now, only resell model is managed (i.e. a bp_finance of BP VAD/IR/DR buy a subscription for one of his customer companies (EC) or bp_finance of BP VAD buy a subscription for one of his BP IR).
This API can be used to create a subscription for a company to a given offer.
If BP company have resell businessModel, his bpApplicantNumber must exist in Business Store (i.e. API GET /api/rainbow/subscription/v1.0/companies/check-applicant-number/{bpApplicantNumber} must return true).
Note: BP IR companies should not have a bpApplicantNumber, as they don't pay directly ALE (their BP VAD does).
superadmin can create subscriptions for every company. superadmin can create subscription even for offers which can't be sold (not paid offers, like beta, Enterprise Demo, ...).
business_admin can create subscriptions for every company. business_admin can create subscription only for demo offers. If business_admin tries to subscribe to an offer that is not a demo offer, request is rejected with a 400 bad request error.
bp_finance can only create subscriptions for End Customer companies / BP IR companies for which bp_finance's company is the BP company.
Users being both bp_finance and organization_admin can create subscription for all the companies being in their organization and the End Customers / BP IR being linked to BP companies of the organisation.
Only superadmin and bp_finance can create subscriptions (for now at least), users with admin role alone are denied.
bp_finance of BP IR companies can only create subscriptions for End Customer companies / their own BP IR companies to pre-paid offers, and only if their VAD have set the fieldadminHasRightToUpdateSubscriptions to true for this BP IR company.
Creating a subscription corresponds to a company buying a paid offer. Therefore, a subscription links a company to an offer.
The list of offers which can be bought can be listed using API GET /api/rainbow/subscription/v1.0/companies/:companyId/offers (warning: the offers already bought are also listed).
The offer has to be in the catalog assigned to the BP company, otherwise an error 403 is returned (except if subscription creation is done by superadmin).
The offers have a businessModel corresponding to the way they are sold.
nb_users or nb_services correspond to offers sold for a given number of users (licences). maxNumberUsers.nb_users or nb_services, maxNumberUsers must be provided (it must be > 0).maxNumberUsers corresponds to the maximum number of users who can be assigned to the subscription of this offer.nb_users or nb_services, a quotation can be made using API POST /api/rainbow/subscription/v1.0/companies/:companyId/quotations.nb_services, the company subscription can be assigned to as many users as available licences (field maxNumberUsers of subscription objects) using API POST /api/rainbow/admin/v1.0/users/{userId}/profiles/subscriptions/{subscriptionId}.usage correspond to offers for which billing will be done according to customer consumption (minutes of conference, TB of storage, ...). usage (as the invoice will depend of customer consumption)<message id=\"8413b42e-563c-4437-9a53-06f638b5ab69_0\" type=\"management\" from=\"pcloud_subscription_1@openrainbow.com/172440802160413612281463752830017532\" to=\"5abb735b2d3c4e50adde276c50ec489c@@openrainbow.com\" xmlns=\"jabber:client\"> <companysubscription xmlns=\"jabber:iq:configuration\" subscriptionId=\"5808afeb4372eb19547e90cf\" companyId=\"58bd63d5dc5ef5eb3fe154c0\" action=\"create\"> <offerId>58072f646237427a3687dc90</offerId> <offerName>Enterprise</offerName> <profileId>57cd90ddc04fd92e232ae258</profileId> <profileName>Enterprise</profileName> <status>creating</status> <syncOngoing>true</syncOngoing> <maxNumberUsers>50</maxNumberUsers> </companysubscription> </message>status field with value creating and the syncOngoing flag indicates that the creation is ongoing on Business Store and Zuora side. status equal to active and syncOngoing equal to false. provisioningOngoing in provisioningNeeded array indicates the status of the creation on PGI/JANUS."
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [],
"body": "{\n \"data\": {\n \"id\": \"59199637d3f06c2fdc40b95e\",\n \"offerId\": \"580e05670f3cce8315072657\",\n \"offerName\": \"Enterprise\",\n \"offerDescription\": \"Rainbow Enterprise offer\",\n \"offerTechnicalDescription\": \"Enterprise offer for BP VAD\",\n \"sapReference\": \"3EY95003AA\",\n \"offerReference\": \"RB-Enterprise\",\n \"profileId\": \"580778556fbd22a442d4fb58\",\n \"profileName\": \"Enterprise\",\n \"isDefault\": false,\n \"businessModel\": \"nb_users\",\n \"isExclusive\": true,\n \"zuoraOfferId\": \"2c92c0f95a6b227b015a84cd5d087031\",\n \"zuoraProductRatePlanId\": \"2c92c0f95a6b227b015a84cd5d9d7043\",\n \"zuoraProductRatePlanChargeId\": \"2c92c0f95a6b227b015a84cd5db67045\",\n \"creationDate\": \"2017-05-15T11:51:19.180Z\",\n \"createdBy\": {\n \"bpApplicantNumber\": \"HAGSH87176\", \n \"loginEmail\": \"bpfinance@bp.fr\",\n \"userId\": \"589dea575a5f36a336a65704\"\n },\n \"status\": \"creating\",\n \"syncOngoing\": true,\n \"bsSubscriptionId\": \"RB-201705005659\",\n \"maxNumberUsers\": 50,\n \"purchaseOrderNumber\": \"my po\"\n }\n}"
}
]
},
{
"name": "Delete a subscription",
"request": {
"method": "DELETE",
"url": {
"raw": "{{SubscriptionPortalServer}}/api/rainbow/subscription/v1.0/companies/:companyId/subscriptions/:subscriptionId",
"host": [
"{{SubscriptionPortalServer}}"
],
"path": [
"api",
"rainbow",
"subscription",
"v1.0",
"companies",
":companyId",
"subscriptions",
":subscriptionId"
],
"variable": [
{
"key": "companyId",
"description": "Company unique identifier (like 569ce8c8f9336c471b98eda1)"
},
{
"key": "subscriptionId",
"description": "Company subscription unique identifier."
}
]
},
"header": [
{
"key": "accept",
"name": "accept",
"value": "application/json",
"description": "application/json",
"type": "text",
"disabled": false
}
],
"body": {},
"description": "Required role(s): `bp_finance`\n\nThis API can be used to delete or terminate a given company subscription.
superadmin can delete subscriptions for every company. superadmin can delete subscription even for offers which can't be sold (not paid offers, like beta, Enterprise Demo, ...).
business_admin can delete subscriptions for every company. business_admin can delete subscription only for demo offers. If business_admin user tries to delete a subscription that is not about a demo offer, an error 400 bad request is thrown.
bp_finance can only delete subscriptions for End Customer companies for which the bp_finance's company is the BP company.
Subscriptions to prepaid offers can be terminated using this API only during the month the subscription was created (e.g. if subscription was created the 15th of september, it can be cancelled until the 1st of october. After that subscription can't be cancelled).
Prepaid offers auto renewal can be cancelled using API PUT /api/rainbow/subscription/v1.0/companies/:companyId/subscriptions/:subscriptionId and it will be terminated when expirationDate will be reached.
Subscriptions not being in Business Store / Zuora are deleted (i.e. subscriptions to free offers like beta, Enterprise Demo, ...) from Rainbow database.
Others subscriptions (known on Zuora) are tagged with status terminated.
Default subscription can't be deleted.
When the subscription is deleted/terminated, the profile of all users being linked to this subscription is updated (the profile linking to this subscription is removed).
When the subscription is deleted, all company_admin of the company and all the bp_admin and bp_finance of the BP company linked to this company are notified with the following XMPP message:
<message id="8413b42e-563c-4437-9a53-06f638b5ab69_0" type="management" from="pcloud_subscription_1@openrainbow.com/172440802160413612281463752830017532" to="5abb735b2d3c4e50adde276c50ec489c@@openrainbow.com" xmlns="jabber:client"> <companysubscription xmlns="jabber:iq:configuration" subscriptionId="5808afeb4372eb19547e90cf" companyId="58bd63d5dc5ef5eb3fe154c0" action="delete"></companysubscription> </message>This API can be used to delete or terminate a given company subscription.
superadmin can delete subscriptions for every company. superadmin can delete subscription even for offers which can't be sold (not paid offers, like beta, Enterprise Demo, ...).
business_admin can delete subscriptions for every company. business_admin can delete subscription only for demo offers. If business_admin user tries to delete a subscription that is not about a demo offer, an error 400 bad request is thrown.
bp_finance can only delete subscriptions for End Customer companies for which the bp_finance's company is the BP company.
Subscriptions to prepaid offers can be terminated using this API only during the month the subscription was created (e.g. if subscription was created the 15th of september, it can be cancelled until the 1st of october. After that subscription can't be cancelled).
Prepaid offers auto renewal can be cancelled using API PUT /api/rainbow/subscription/v1.0/companies/:companyId/subscriptions/:subscriptionId and it will be terminated when expirationDate will be reached.
Subscriptions not being in Business Store / Zuora are deleted (i.e. subscriptions to free offers like beta, Enterprise Demo, ...) from Rainbow database.
Others subscriptions (known on Zuora) are tagged with status terminated.
Default subscription can't be deleted.
When the subscription is deleted/terminated, the profile of all users being linked to this subscription is updated (the profile linking to this subscription is removed).
When the subscription is deleted, all company_admin of the company and all the bp_admin and bp_finance of the BP company linked to this company are notified with the following XMPP message:
<message id="8413b42e-563c-4437-9a53-06f638b5ab69_0" type="management" from="pcloud_subscription_1@openrainbow.com/172440802160413612281463752830017532" to="5abb735b2d3c4e50adde276c50ec489c@@openrainbow.com" xmlns="jabber:client"> <companysubscription xmlns="jabber:iq:configuration" subscriptionId="5808afeb4372eb19547e90cf" companyId="58bd63d5dc5ef5eb3fe154c0" action="delete"></companysubscription> </message>This API can be used to get a subscription of a company.
superadmin and support can get subscriptions of all companies existing in Rainbow.
business_admin can get only demo subscriptions of all companies existing in Rainbow.
bp_admin can only get subscriptions of End Customer companies for which their bp_admin's company is the BP company.
bp_finance can only get subscriptions of End Customer companies for which their bp_finance's company is the BP company.
organization_admin can only get subscriptions of companies under their organisation.
company_admin can get subscriptions only for their company.
Data regarding user assignment is computed and returned for the requested subscription:
bpType=IR and the subscription has businessModel=nb_users, the following fields are computed and added to the subscription data: nbBPLicences: the number of licences available for this subscription (equal to maxNumberUsers),nbAssignedBPUsers: the number of licences assigned to BP company's users for this subscription,nbLicencesAssignedToECs: the number of licences affected to EC companies under the BP IR for which subscription have been bought (linked to the BP IR's subscription)nbLicencesUsed: the number of licences used for this subscription (equal to nbAssignedBPUsers + nbLicencesAssignedToECs)nbFreeLicences: the number of licences available for this subscription (equal to nbBPLicences - nbLicencesUsed)numberAssignedUsers: the number of licences assigned for this subscription (equal to nbLicencesUsed).numberAssignedUsers: the number of licences assigned to company's users for this subscription.This API can be used to get a subscription of a company.
superadmin and support can get subscriptions of all companies existing in Rainbow.
business_admin can get only demo subscriptions of all companies existing in Rainbow.
bp_admin can only get subscriptions of End Customer companies for which their bp_admin's company is the BP company.
bp_finance can only get subscriptions of End Customer companies for which their bp_finance's company is the BP company.
organization_admin can only get subscriptions of companies under their organisation.
company_admin can get subscriptions only for their company.
Data regarding user assignment is computed and returned for the requested subscription:
bpType=IR and the subscription has businessModel=nb_users, the following fields are computed and added to the subscription data: nbBPLicences: the number of licences available for this subscription (equal to maxNumberUsers),nbAssignedBPUsers: the number of licences assigned to BP company's users for this subscription,nbLicencesAssignedToECs: the number of licences affected to EC companies under the BP IR for which subscription have been bought (linked to the BP IR's subscription)nbLicencesUsed: the number of licences used for this subscription (equal to nbAssignedBPUsers + nbLicencesAssignedToECs)nbFreeLicences: the number of licences available for this subscription (equal to nbBPLicences - nbLicencesUsed)numberAssignedUsers: the number of licences assigned for this subscription (equal to nbLicencesUsed).numberAssignedUsers: the number of licences assigned to company's users for this subscription.This API can be used to get a subscription of a company.
superadmin and support can get subscriptions of all companies existing in Rainbow.
business_admin can get only demo subscriptions of all companies existing in Rainbow.
bp_admin can only get subscriptions of End Customer companies for which their bp_admin's company is the BP company.
bp_finance can only get subscriptions of End Customer companies for which their bp_finance's company is the BP company.
organization_admin can only get subscriptions of companies under their organisation.
company_admin can get subscriptions only for their company.
Data regarding user assignment is computed and returned for the requested subscription:
bpType=IR and the subscription has businessModel=nb_users, the following fields are computed and added to the subscription data: nbBPLicences: the number of licences available for this subscription (equal to maxNumberUsers),nbAssignedBPUsers: the number of licences assigned to BP company's users for this subscription,nbLicencesAssignedToECs: the number of licences affected to EC companies under the BP IR for which subscription have been bought (linked to the BP IR's subscription)nbLicencesUsed: the number of licences used for this subscription (equal to nbAssignedBPUsers + nbLicencesAssignedToECs)nbFreeLicences: the number of licences available for this subscription (equal to nbBPLicences - nbLicencesUsed)numberAssignedUsers: the number of licences assigned for this subscription (equal to nbLicencesUsed).numberAssignedUsers: the number of licences assigned to company's users for this subscription.This API can be used to get features available to the company through its subscriptions.
Subscriptions bring to the company features (through a profile depending of the subscribed offer). Each subscription has his own list of features with their own value.
Company can have several subscriptions (if the company has subscribed to commercial offers). By default, company has at least a subscription to the default offer (i.e. Essential).
This API allows to aggregate all features from all company's subscriptions, listing therefore all available features for this company.
superadmin and support can get company features of all companies existing in Rainbow. bp_admin can only get company features of End Customer companies for which their bp_admin's company is the BP company. bp_finance can only get company features of End Customer companies for which their bp_finance's company is the BP company. organization_admin can only get company features of companies under their organisation. company_admin can get company features only for their company. user can get company features only for their company.
Example: GET https://openrainbow.com/api/rainbow/subscription/v1.0/companies/569ce8c8f9336c471b98eda1/subscriptions/features
" }, "response": [ { "name": "Success-Response:", "originalRequest": { "method": "GET", "url": { "raw": "{{SubscriptionPortalServer}}/api/rainbow/subscription/v1.0/companies/:companyId/subscriptions/features", "host": [ "{{SubscriptionPortalServer}}" ], "path": [ "api", "rainbow", "subscription", "v1.0", "companies", ":companyId", "subscriptions", "features" ], "variable": [ { "key": "companyId", "description": "Company unique identifier (like 569ce8c8f9336c471b98eda1)" } ] }, "header": [ { "key": "accept", "name": "accept", "value": "application/json", "description": "application/json", "type": "text", "disabled": false } ], "body": {}, "description": "Required role(s): `business_admin`, `bp_admin`, `bp_finance`, `organization_admin`, `company_admin`, `user`, `guest`\n\nThis API can be used to get features available to the company through its subscriptions.
Subscriptions bring to the company features (through a profile depending of the subscribed offer). Each subscription has his own list of features with their own value.
Company can have several subscriptions (if the company has subscribed to commercial offers). By default, company has at least a subscription to the default offer (i.e. Essential).
This API allows to aggregate all features from all company's subscriptions, listing therefore all available features for this company.
superadmin and support can get company features of all companies existing in Rainbow. bp_admin can only get company features of End Customer companies for which their bp_admin's company is the BP company. bp_finance can only get company features of End Customer companies for which their bp_finance's company is the BP company. organization_admin can only get company features of companies under their organisation. company_admin can get company features only for their company. user can get company features only for their company.
Example: GET https://openrainbow.com/api/rainbow/subscription/v1.0/companies/569ce8c8f9336c471b98eda1/subscriptions/features
" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [], "body": "{\n \"data\": [\n {\n \"featureId\": \"580773787853994e42d90f0b\",\n \"featureUniqueRef\": \"COMPANY_ADMIN_ALLOWED_NB\",\n \"featureName\": \"Company admin\",\n \"featureType\": \"number\",\n \"limitMax\": 10,\n \"addedDate\": \"2017-02-16T11:22:54.270Z\",\n \"lastUpdateDate\": \"2017-02-16T11:22:54.270Z\"\n },\n {\n \"featureId\": \"580e02660f3cce8315072656\",\n \"featureUniqueRef\": \"MASSPRO_USER_PROVISIONING_CSV\",\n \"featureName\": \"Mass user provisioning using CSV file\",\n \"featureType\": \"boolean\",\n \"isEnabled\": true,\n \"addedDate\": \"2017-02-16T11:23:29.296Z\",\n \"lastUpdateDate\": \"2017-02-16T11:23:29.296Z\"\n }\n ]\n}" } ] }, { "name": "Get company subscriptions", "request": { "method": "GET", "url": { "raw": "{{SubscriptionPortalServer}}/api/rainbow/subscription/v1.0/companies/:companyId/subscriptions", "host": [ "{{SubscriptionPortalServer}}" ], "path": [ "api", "rainbow", "subscription", "v1.0", "companies", ":companyId", "subscriptions" ], "variable": [ { "key": "companyId", "description": "Company unique identifier (like 569ce8c8f9336c471b98eda1)" } ], "query": [ { "key": "format", "value": "small", "description": "Allows to retrieve more or less subscription details in response.superadmin, business_admin and support can list subscriptions of all companies existing in Rainbow. business_admin can list only demo subscriptions of all companies existing in Rainbow. bp_admin can only list subscriptions of End Customer companies for which their bp_admin's company is the BP company. bp_finance can only list subscriptions of End Customer companies for which their bp_finance's company is the BP company. organization_admin can only list subscriptions of companies under their organisation. company_admin can list subscriptions only for their company. bpType=IR and the subscription has businessModel=nb_users, the following fields are computed and added to the subscription data: nbBPLicences: the number of licences available for this subscription (equal to maxNumberUsers),nbAssignedBPUsers: the number of licences assigned to BP users for this subscription,nbLicencesAssignedToECs: the number of licences assigned to users of EC companies under the BP IR for which subscription have been bought (linked to the BP IR's subscription)nbLicencesUsed: the number of licences used for this subscription (equal to nbAssignedBPUsers + nbLicencesAssignedToECs)nbFreeLicences: the number of licences available for this subscription (equal to nbBPLicences - nbLicencesUsed)numberAssignedUsers: the number of licences assigned for this subscription (equal to nbLicencesUsed). Added for compatibility so that in all cases this field is set.numberAssignedUsers: the number of licences assigned to company users for this subscription.superadmin, business_admin and support can list subscriptions of all companies existing in Rainbow. business_admin can list only demo subscriptions of all companies existing in Rainbow. bp_admin can only list subscriptions of End Customer companies for which their bp_admin's company is the BP company. bp_finance can only list subscriptions of End Customer companies for which their bp_finance's company is the BP company. organization_admin can only list subscriptions of companies under their organisation. company_admin can list subscriptions only for their company. bpType=IR and the subscription has businessModel=nb_users, the following fields are computed and added to the subscription data: nbBPLicences: the number of licences available for this subscription (equal to maxNumberUsers),nbAssignedBPUsers: the number of licences assigned to BP users for this subscription,nbLicencesAssignedToECs: the number of licences assigned to users of EC companies under the BP IR for which subscription have been bought (linked to the BP IR's subscription)nbLicencesUsed: the number of licences used for this subscription (equal to nbAssignedBPUsers + nbLicencesAssignedToECs)nbFreeLicences: the number of licences available for this subscription (equal to nbBPLicences - nbLicencesUsed)numberAssignedUsers: the number of licences assigned for this subscription (equal to nbLicencesUsed). Added for compatibility so that in all cases this field is set.numberAssignedUsers: the number of licences assigned to company users for this subscription.superadmin, business_admin and support can list subscriptions of all companies existing in Rainbow. business_admin can list only demo subscriptions of all companies existing in Rainbow. bp_admin can only list subscriptions of End Customer companies for which their bp_admin's company is the BP company. bp_finance can only list subscriptions of End Customer companies for which their bp_finance's company is the BP company. organization_admin can only list subscriptions of companies under their organisation. company_admin can list subscriptions only for their company. bpType=IR and the subscription has businessModel=nb_users, the following fields are computed and added to the subscription data: nbBPLicences: the number of licences available for this subscription (equal to maxNumberUsers),nbAssignedBPUsers: the number of licences assigned to BP users for this subscription,nbLicencesAssignedToECs: the number of licences assigned to users of EC companies under the BP IR for which subscription have been bought (linked to the BP IR's subscription)nbLicencesUsed: the number of licences used for this subscription (equal to nbAssignedBPUsers + nbLicencesAssignedToECs)nbFreeLicences: the number of licences available for this subscription (equal to nbBPLicences - nbLicencesUsed)numberAssignedUsers: the number of licences assigned for this subscription (equal to nbLicencesUsed). Added for compatibility so that in all cases this field is set.numberAssignedUsers: the number of licences assigned to company users for this subscription.This API can be used to list counters regarding all offers subscribed by a BP company and its customers / resellers.
This API can only be used for BP companies (whatever the bpType).
For each subscribed offer, this API returns:
This API can be used to list counters regarding all offers subscribed by a BP company and its customers / resellers.
This API can only be used for BP companies (whatever the bpType).
For each subscribed offer, this API returns:
This API can be used to get default subscription of a company (i.e. subscription to default Rainbow offer).
superadmin, business_admin and support can get default subscription of all companies existing in Rainbow.
bp_admin can only get default subscription of End Customer companies for which their bp_admin's company is the BP company.
bp_finance can only get default subscription of End Customer companies for which their bp_finance's company is the BP company.
organization_admin can only get default subscription of companies under their organisation.
company_admin can get default subscription only for their company.
Example: GET https://openrainbow.com/api/rainbow/subscription/v1.0/companies/569ce8c8f9336c471b98eda1/subscriptions/default
This API can be used to get default subscription of a company (i.e. subscription to default Rainbow offer).
superadmin, business_admin and support can get default subscription of all companies existing in Rainbow.
bp_admin can only get default subscription of End Customer companies for which their bp_admin's company is the BP company.
bp_finance can only get default subscription of End Customer companies for which their bp_finance's company is the BP company.
organization_admin can only get default subscription of companies under their organisation.
company_admin can get default subscription only for their company.
Example: GET https://openrainbow.com/api/rainbow/subscription/v1.0/companies/569ce8c8f9336c471b98eda1/subscriptions/default
This API can be used to list prepaid subscriptions ending soon
superadmin and support can list prepaid subscriptions of any company(ies) existing in Rainbow.
bp_finance can only list prepaid subscriptions of End Customer companies linked to their BP company.
company_admin can only list prepaid subscriptions of his own End Customer company.
Example: GET https://openrainbow.com/api/rainbow/subscription/v1.0/companies/569ce8c8f9336c471b98eda1/subscriptions/prepaid
This API can be used to list prepaid subscriptions ending soon
superadmin and support can list prepaid subscriptions of any company(ies) existing in Rainbow.
bp_finance can only list prepaid subscriptions of End Customer companies linked to their BP company.
company_admin can only list prepaid subscriptions of his own End Customer company.
Example: GET https://openrainbow.com/api/rainbow/subscription/v1.0/companies/569ce8c8f9336c471b98eda1/subscriptions/prepaid
superadmin and support can get users attached to any company subscriptions existing in Rainbow. bp_admin can only retrieve users attached to subscriptions of End Customer companies linked to their BP company. bp_finance can only retrieve users attached to subscriptions of End Customer companies linked to their BP company. organization_admin can only retrieve users attached to subscriptions of companies under their organisation. company_admin can only retrieve users attached to subscriptions of their company. superadmin and support can get users attached to any company subscriptions existing in Rainbow. bp_admin can only retrieve users attached to subscriptions of End Customer companies linked to their BP company. bp_finance can only retrieve users attached to subscriptions of End Customer companies linked to their BP company. organization_admin can only retrieve users attached to subscriptions of companies under their organisation. company_admin can only retrieve users attached to subscriptions of their company. This API can be used to update a given company subscription.
Currently only maxNumberUsers can be updated, so update is restricted to subscriptions linked to offers having businessModel nb_users.
Now also autoRenew can be updated using this API. In this case, update is limited to subscriptions to prepaid offers
The subscription can only be updated if it is not synchronizing with Business Store and Zuora (i.e. syncOngoing must be equal to false).
If BP company have resell businessModel, his bpApplicantNumber must exist in Business Store (i.e. API GET /api/rainbow/subscription/v1.0/companies/check-applicant-number/{bpApplicantNumber} must return true).
Note: BP IR companies should not have a bpApplicantNumber, as they don't pay directly ALE (their BP VAD does).
business_admin can update demo subscriptions for all existing companies. If business_admin user tries to update a subscription that is not about a demo offer, an error 400 bad request is thrown.
bp_finance can only update subscriptions for End Customer companies for which the bp_finance's company is the BP company.
company_admin can only update subscriptions for their own company (except if their company is linked to a BP IR company, in that case they are not allowed to update subscriptions of their company).
bp_admin or bp_finance can forbid administrators of his End Customer companies to:
adminHasRightToUpdateSubscriptions),maxNumberUsers of his subscriptions (company flag adminAllowedUpdateSubscriptionsOps set to increase_only),maxNumberUsers of subscriptions to prepaid offers can be increase to any value. maxNumberUsers of subscriptions to prepaid offers can be decreased ONLY if a prepaid addon has been created during the month of the request (e.g. if a prepaid addon is created the 15th of september with 10 licenses, I'll be able to decrease the maxNumberUsers up to 10 licenses and until the 1st of october). This feature allows admin to cancel an addon to a prepaid subscription. maxNumberUsers of monthly subscriptions can be increase to any value. maxNumberUsers of monthly subscriptions can only be decreased to remove \"free\" licences, i.e. licences which are not already assigned to users (updated maxNumberUsers must be greater or equal to numberAssignedUsers). To remove additional licences, admin first have to un-assign licences to some users using API DELETE /api/rainbow/admin/v1.0/users/{userId}/profiles/subscriptions/{subscriptionId}. <message id=\"8413b42e-563c-4437-9a53-06f638b5ab69_0\" type=\"management\" from=\"pcloud_subscription_1@openrainbow.com/172440802160413612281463752830017532\" to=\"5abb735b2d3c4e50adde276c50ec489c@@openrainbow.com\" xmlns=\"jabber:client\"> <companysubscription xmlns=\"jabber:iq:configuration\" subscriptionId=\"5808afeb4372eb19547e90cf\" companyId=\"58bd63d5dc5ef5eb3fe154c0\" action=\"update\"> <offerId>58072f646237427a3687dc90</offerId> <offerName>Enterprise</offerName> <profileId>57cd90ddc04fd92e232ae258</profileId> <profileName>Enterprise</profileName> <status>active</status> <syncOngoing>true</syncOngoing> <maxNumberUsers>50</maxNumberUsers> </companysubscription> </message>syncOngoing flag indicates that the update is being synchronizing with Business Store and Zuora. It will not be possible to update again the subscription as long the synchronization is ongoing. syncOngoing equal to false."
},
"response": [
{
"name": "Success-Response:",
"originalRequest": {
"method": "PUT",
"url": {
"raw": "{{SubscriptionPortalServer}}/api/rainbow/subscription/v1.0/companies/:companyId/subscriptions/:subscriptionId",
"host": [
"{{SubscriptionPortalServer}}"
],
"path": [
"api",
"rainbow",
"subscription",
"v1.0",
"companies",
":companyId",
"subscriptions",
":subscriptionId"
],
"variable": [
{
"key": "companyId",
"description": "Company unique identifier (like 569ce8c8f9336c471b98eda1)"
},
{
"key": "subscriptionId",
"description": "Company subscription unique identifier."
}
]
},
"header": [
{
"key": "accept",
"name": "accept",
"value": "application/json",
"description": "application/json",
"type": "text",
"disabled": false
},
{
"key": "content-type",
"name": "content-type",
"value": "application/json",
"description": "application/json",
"type": "text",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"maxNumberUsers\": 100,\n \"renewalTermOption\": \"initial\",\n \"prepaidRenewalOption\": \"allocated\"\n}"
},
"description": "Required role(s): `business_admin`, `bp_finance`, `organization_admin`, `company_admin`\n\nThis API can be used to update a given company subscription.
Currently only maxNumberUsers can be updated, so update is restricted to subscriptions linked to offers having businessModel nb_users.
Now also autoRenew can be updated using this API. In this case, update is limited to subscriptions to prepaid offers
The subscription can only be updated if it is not synchronizing with Business Store and Zuora (i.e. syncOngoing must be equal to false).
If BP company have resell businessModel, his bpApplicantNumber must exist in Business Store (i.e. API GET /api/rainbow/subscription/v1.0/companies/check-applicant-number/{bpApplicantNumber} must return true).
Note: BP IR companies should not have a bpApplicantNumber, as they don't pay directly ALE (their BP VAD does).
business_admin can update demo subscriptions for all existing companies. If business_admin user tries to update a subscription that is not about a demo offer, an error 400 bad request is thrown.
bp_finance can only update subscriptions for End Customer companies for which the bp_finance's company is the BP company.
company_admin can only update subscriptions for their own company (except if their company is linked to a BP IR company, in that case they are not allowed to update subscriptions of their company).
bp_admin or bp_finance can forbid administrators of his End Customer companies to:
adminHasRightToUpdateSubscriptions),maxNumberUsers of his subscriptions (company flag adminAllowedUpdateSubscriptionsOps set to increase_only),maxNumberUsers of subscriptions to prepaid offers can be increase to any value. maxNumberUsers of subscriptions to prepaid offers can be decreased ONLY if a prepaid addon has been created during the month of the request (e.g. if a prepaid addon is created the 15th of september with 10 licenses, I'll be able to decrease the maxNumberUsers up to 10 licenses and until the 1st of october). This feature allows admin to cancel an addon to a prepaid subscription. maxNumberUsers of monthly subscriptions can be increase to any value. maxNumberUsers of monthly subscriptions can only be decreased to remove \"free\" licences, i.e. licences which are not already assigned to users (updated maxNumberUsers must be greater or equal to numberAssignedUsers). To remove additional licences, admin first have to un-assign licences to some users using API DELETE /api/rainbow/admin/v1.0/users/{userId}/profiles/subscriptions/{subscriptionId}. <message id=\"8413b42e-563c-4437-9a53-06f638b5ab69_0\" type=\"management\" from=\"pcloud_subscription_1@openrainbow.com/172440802160413612281463752830017532\" to=\"5abb735b2d3c4e50adde276c50ec489c@@openrainbow.com\" xmlns=\"jabber:client\"> <companysubscription xmlns=\"jabber:iq:configuration\" subscriptionId=\"5808afeb4372eb19547e90cf\" companyId=\"58bd63d5dc5ef5eb3fe154c0\" action=\"update\"> <offerId>58072f646237427a3687dc90</offerId> <offerName>Enterprise</offerName> <profileId>57cd90ddc04fd92e232ae258</profileId> <profileName>Enterprise</profileName> <status>active</status> <syncOngoing>true</syncOngoing> <maxNumberUsers>50</maxNumberUsers> </companysubscription> </message>syncOngoing flag indicates that the update is being synchronizing with Business Store and Zuora. It will not be possible to update again the subscription as long the synchronization is ongoing. syncOngoing equal to false."
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [],
"body": "{\n \"data\": {\n \"id\": \"5808afeb4372eb19547e90cf\",\n \"offerId\": \"58072f646237427a3687dc90\",\n \"offerName\": \"Enterprise\",\n \"offerDescription\": \"Rainbow Enterprise offer\",\n \"offerTechnicalDescription\": \"Enterprise offer for BP VAD\",\n \"sapReference\": \"3EY95003AA\",\n \"offerReference\": \"RB-Enterprise\",\n \"profileId\": \"57cd90ddc04fd92e232ae258\",\n \"profileName\": \"Enterprise\",\n \"isDefault\": false,\n \"businessModel\": \"nb_users\",\n \"isExclusive\": true,\n \"zuoraOfferId\": \"2c92c0f95a6b227b015a84cd5d087031\",\n \"zuoraProductRatePlanId\": \"2c92c0f95a6b227b015a84cd5d9d7043\",\n \"zuoraProductRatePlanChargeId\": \"2c92c0f95a6b227b015a84cd5db67045\",\n \"creationDate\": \"2017-03-28T12:37:37.959Z\",\n \"createdBy\": {\n \"userId\": \"5891dd587be005b39a4ee7bf\",\n \"loginEmail\": \"bp_finance@bp-company.com\",\n \"bpApplicantNumber\": \"The applicant number of the BP\" \n },\n \"status\": \"active\",\n \"syncOngoing\": true,\n \"bsSubscriptionId\": \"RB-201705005659\",\n \"zuoraSubscriptionId\": \"2c92c0fb5ca5c5bc015ca6feafbc7995\",\n \"maxNumberUsers\": 50,\n \"updatingMaxNumberUsers\": 100,\n \"numberAssignedUsers\": 50,\n \"bpBusinessType\": \"default\",\n \"purchaseOrderNumber\": \"my po\"\n }\n}"
}
]
}
]
}
]
}