Skip to content
Last updated

Preparing Your Dynamic Monetization Instance: Information for Producers Using a Custom Back Office

If you do not use FlexNet Operations but have your own back office for managing your entitlements, then you will need to use the Dynamic Monetization APIs directly to:

  • Create Dynamic Monetization instances for your customer accounts
  • Create and modify line items in Dynamic Monetization

You may want to write an integration layer that allows your back office to call these APIs directly.

The remainder of this section on using your own back office walks you through exercises for managing instances and line items:

  1. Creating a Dynamic Monetization Instance
  2. Creating a Line Item

For information about authorization requirements for the Dynamic Monetization APIs, see the Dynamic Monetization Authorization Guide. You can download this document from the Product and License Center (login required).

Creating a Dynamic Monetization Instance


Authorization: administration token

Endpoint information: Create an instance


This section describes the steps for using the POST /instances API to create an instance for a customer account.

Important: If this is the first instance created for a specific account, it will be created as the default instance.

Send a POST to /provisioning/api/v1.0/instances. Use the values as described in the following table:

ItemDescription
URI/provisioning/api/v1.0/instances
MethodPOST
Query parametersN/A
Request body
{ 
  "shortName": "ACME-def-inst",
  "accountId": "ACME"
} 

Sample Response

If the request was successful, the response returns the instance information, similar to this:

{
    "id": "d889a651-123a-456b-78d9-60d6de8cfes9",
    "shortName": "ACME-def-inst",
    "accountId": "ACME",
    "defaultInstance": true,
    "created": 1,
    "modified": 0
}

Creating a Line Item


Authorization: administration token

Endpoint information: Map a line item to an instance


In this exercise, you create a line item which captures an entitlement to a number of metered tokens that a customer has purchased.

Send a PUT request to /provisioning/api/v1.0/instances/{instanceId}/line-items to map a line item to the instance you created in the previous step, Creating a Line Item.


ItemDescription
URI/provisioning/api/v1.0/instances/{instanceId}/line-items
MethodPUT
Path parametersinstanceId: Use the ID returned by the /provisioning/api/v1.0/instances API
Request body
{ 
  "activationId": "ACT01-Elastic",
  "state": "active",
  "quantity": 1000,
  "start": 1695772800000,
  "end": 1790380800000,
  "attributes": {
    "elastic": true,
    "rateTableSeries": "PublicationApps",
    "overdraftLimit": 0,
    "overdraftType": "Number"
  },
  "instanceId": "d889a651-123a-456b-78d9-60d6de8cfes9"
} 

Sample Response

If the request was successful, the response returns code 201, indicating that the line item was successfully created.

{
  "message": "Success"
{