Billing: LicenseAttached
LicenseAttached
Notification event that a license has been created or assigned.
This must create and/or assign the license to the correct account in the billing system.
Note: For easier support in languages like PHP, the license array passed to this event is serialized
Authentication Methods
- ApiKey
Input Parameter | Type | Description |
---|---|---|
BrandingID* | String | The branding ID will determine what pricing to use Example:'NMD' |
Owner* | String | This is the account name of the group manager that is the owner these licenses Example:'nmua000001' |
Subscription[x][assignee][y][licenseid] | String | Required if the 'asignee' array is set. Contains the LicenseID(GUID) from the controller. Example:'0054a852-5fab-8852-5f16-03e138f04a24' |
Subscription[x][assignee][y][name] | String | Required if the 'asignee' array is set This is the account name(nmua number) that the license is being assigned to. Example:nmua000002 |
Subscription[x][assignee][y][exists] | String | Required if the 'asignee' array is set. True if the license already existed in Nomadesk, false if it's a new license |
Subscription[x][licenseid][] | String | List of new unassigned licenses strings passed are the LicenseID's from in Nomadesk Example:Array ( [0] => 0054a852-5fab-8852-5f16-03e138f04a24 [1] => fc4f1cf2-c2ed-1c31-189c-8f59b27b616b ) |
Subscription[x][type] | String | This is the license type Possible values: 'Monthly', 'Yearly', 'Free', 'Grace', 'Personal' |
*=required
Examples
Request:
URL: https://example.com/billing/Api
POST values example:
[owner] => nmua000008
[brandingid] => NMD
[task] => LicenseAttached
[subscription] => Array (
[0] => Array (
[type] => Yearly
[assignee] => Array (
[0] => Array (
[licenseid] => 62794011-9046-b8c5-8a60-30aaee11099f
[name] => nmua000001
[exists] => false
)
[1] => Array (
[licenseid] => 0054a852-5fab-8852-5f16-03e138f04a24
[name] => nmua000002
[exists] => true
)
)
[licenseid] => Array (
[0] => fc4f1cf2-c2ed-1c31-189c-8f59b27b616b
)
)
[1] => Array (
[type] => Monthly
[assignee] => Array (
[0] => Array (
[licenseid] => 62794011-9046-b8c5-8a60-30aaee11099f
[name] => nmua000003
[exists] => false
)
[1] => Array (
[licenseid] => 0054a852-5fab-8852-5f16-03e138f04a24
[name] => nmua000004
[exists] => true
)
)
[licenseid] => Array (
[0] => fc4f1cf2-c2ed-1c31-189c-8f59b27b616b
)
)
)
Response:
<Response>
<Header>
<Status>1</Status>
<Message></Message>
<CreationDstamp></CreationDstamp>
</Header>
</Response>