Skip to content
/Line Items

Dynamic Monetization APIs (1.0)

APIs to perform Dynamic Monetization activity.

Download OpenAPI description
OpenAPISpec.json
OpenAPISpec.yaml
Languages
Servers
Dynamic Monetization API URL

https://{siteID}.flexnetoperations.{domainExtension}/dynamicmonetization/api/

Dynamic Monetization API URL

https://{siteID}.flexnetoperations.{domainExtension}/dynamicmonetization/floating/api/

Authorization

APIs to manage authorization keys.

Operations

Instances

APIs to manage Dynamic Monetization instances, which host the line items belonging to customers.

Operations

Line Items

APIs to manage line items mapped to an instance.

Operations

Get a list of line items

Request

Returns a list of line items mapped to instances owned by a producer's customer accounts.

Security
AdministrationAccess or ClientAccess
Path
instanceIdstring(uuid)required

The UUID of the Dynamic Monetization instance.

curl -i -X GET \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/provisioning/api/v1.0/instances/{instanceId}/line-items' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of line items for the instance ID.

Bodyapplication/jsonArray [
activationIdstringrequired

The activation ID of a line item that should be mapped to the instance.

statestring(LineItemState)required

The line item state. Valid states are:

  • DEPLOYED
  • INACTIVE
  • OBSOLETE

INACTIVE and OBSOLETE can only be set when the line item already exists.
An OBSOLETE line item cannot be set to INACTIVE or DEPLOYED.

quantityinteger(int64)>= 1required

The quantity from the line item to map to the instance.

startinteger(int64)required

Start date and time of the line item in milliseconds since 1970-01-01 00:00.

endinteger(int64)required

End date and time of the line item in milliseconds since 1970-01-01 00:00.

usednumber(double)read-only

The count from the line item quantity used by access requests. The value can be fractional.

attributesobject(Attributes)required

The properties that determine how the service will respond to access requests.

attributes.​elasticboolean

Indicates whether the line item is elastic.

Default false
attributes.​rateTableSeriesstring

The rate table series used to determine the rate applied to Elastic access requests against this line item. An empty string indicates that the rate is determined by the latest version of a table with no series.

Default ""
attributes.​overdraftLimitinteger

Allow requests to continue consuming tokens from this line item after the entitled quantity has been fully consumed, up to the overdraft limit. The overdraftType field must be set to "Number" if an overdraft limit is provided. To consume tokens from this line item indefinitely, set the overdraftType to "Unlimited", and an overdraft limit is not required. If an overdraft limit is not set, requests can only consume from this line item until the entitled quantity is reached.

attributes.​overdraftTypestring

The type of overdraft. Valid types are:

  • Unlimited
  • Number
]
Response
application/json
[
  {
    "activationId": "string",
    "state": "string",
    "quantity": 1,
    "start": 0,
    "end": 0,
    "used": 0.1,
    "attributes": { … }
  }
]

Map a line item to an instance

Request

Maps a line item to an instance. The first time this API is called, the payload details will be stored, and reported in a GET line-item request. If the line item is already mapped, then the details stored will be entirely replaced.

This method is intended for use if you do not use FlexNet Operations as your back office, so that you can configure your upstream system (e.g. a CRM or back office) to create line items in Dynamic Monetization for your end customers. (If you use FlexNet Operations as your back office, but use this method directly to provision line items that do not exist in FlexNet Operations, then those line items will not be reflected in FlexNet Operations.)

Security
AdministrationAccess
Path
instanceIdstring(uuid)required

The UUID of the Dynamic Monetization instance.

Bodyapplication/jsonrequired
activationIdstringrequired

The activation ID of a line item that should be mapped to the instance.

statestring(LineItemState)required

The line item state. Valid states are:

  • DEPLOYED
  • INACTIVE
  • OBSOLETE

INACTIVE and OBSOLETE can only be set when the line item already exists.
An OBSOLETE line item cannot be set to INACTIVE or DEPLOYED.

quantityinteger(int64)>= 1required

The quantity from the line item to map to the instance.

startinteger(int64)required

Start date and time of the line item in milliseconds since 1970-01-01 00:00.

endinteger(int64)required

End date and time of the line item in milliseconds since 1970-01-01 00:00.

attributesobject(Attributes)required

The properties that determine how the service will respond to access requests.

attributes.​elasticboolean

Indicates whether the line item is elastic.

Default false
attributes.​rateTableSeriesstring

The rate table series used to determine the rate applied to Elastic access requests against this line item. An empty string indicates that the rate is determined by the latest version of a table with no series.

Default ""
attributes.​overdraftLimitinteger

Allow requests to continue consuming tokens from this line item after the entitled quantity has been fully consumed, up to the overdraft limit. The overdraftType field must be set to "Number" if an overdraft limit is provided. To consume tokens from this line item indefinitely, set the overdraftType to "Unlimited", and an overdraft limit is not required. If an overdraft limit is not set, requests can only consume from this line item until the entitled quantity is reached.

attributes.​overdraftTypestring

The type of overdraft. Valid types are:

  • Unlimited
  • Number
curl -i -X PUT \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/provisioning/api/v1.0/instances/{instanceId}/line-items' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "activationId": "string",
    "state": "string",
    "quantity": 1,
    "start": 0,
    "end": 0,
    "attributes": {
      "elastic": false,
      "rateTableSeries": "",
      "overdraftLimit": 0,
      "overdraftType": "string"
    }
  }'

Responses

Returned when a line item is successfully updated.

Bodyapplication/json
string
Response
application/json
"string"

Get a specific line item by ID

Request

Returns information about a specific line item. Pass the line item ID for which you require information as a path parameter.

Security
AdministrationAccess or ClientAccess
Path
instanceIdstring(uuid)required

The UUID of the Dynamic Monetization instance.

lineItemIdstringrequired

Line item ID. Note: This is also known as the activation ID.

curl -i -X GET \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/provisioning/api/v1.0/instances/{instanceId}/line-items/{lineItemId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The requested line item was found and returned successfully.

Bodyapplication/json
activationIdstringrequired

The activation ID of a line item that should be mapped to the instance.

statestring(LineItemState)required

The line item state. Valid states are:

  • DEPLOYED
  • INACTIVE
  • OBSOLETE

INACTIVE and OBSOLETE can only be set when the line item already exists.
An OBSOLETE line item cannot be set to INACTIVE or DEPLOYED.

quantityinteger(int64)>= 1required

The quantity from the line item to map to the instance.

startinteger(int64)required

Start date and time of the line item in milliseconds since 1970-01-01 00:00.

endinteger(int64)required

End date and time of the line item in milliseconds since 1970-01-01 00:00.

usednumber(double)read-only

The count from the line item quantity used by access requests. The value can be fractional.

attributesobject(Attributes)required

The properties that determine how the service will respond to access requests.

attributes.​elasticboolean

Indicates whether the line item is elastic.

Default false
attributes.​rateTableSeriesstring

The rate table series used to determine the rate applied to Elastic access requests against this line item. An empty string indicates that the rate is determined by the latest version of a table with no series.

Default ""
attributes.​overdraftLimitinteger

Allow requests to continue consuming tokens from this line item after the entitled quantity has been fully consumed, up to the overdraft limit. The overdraftType field must be set to "Number" if an overdraft limit is provided. To consume tokens from this line item indefinitely, set the overdraftType to "Unlimited", and an overdraft limit is not required. If an overdraft limit is not set, requests can only consume from this line item until the entitled quantity is reached.

attributes.​overdraftTypestring

The type of overdraft. Valid types are:

  • Unlimited
  • Number
Response
application/json
{
  "activationId": "string",
  "state": "string",
  "quantity": 1,
  "start": 0,
  "end": 0,
  "used": 0.1,
  "attributes": {
    "elastic": false,
    "rateTableSeries": "",
    "overdraftLimit": 0,
    "overdraftType": "string"
  }
}

Delete a line item by its ID

Request

Deletes a line item given its ID.

This method is intended for use if you do not use FlexNet Operations as your back office, so that you can manage line items in Dynamic Monetization for your end customers. (If you use FlexNet Operations as your back office, but use this method directly to remove line items that exist in FlexNet Operations, then those line items' representation in FlexNet Operations will not be affected.)

Security
AdministrationAccess
Path
instanceIdstring(uuid)required

The UUID of the Dynamic Monetization instance.

lineItemIdstringrequired

Line item ID. Note: This is also known as the activation ID.

curl -i -X DELETE \
  'https://{siteid}.flexnetoperations.{domainextension}/dynamicmonetization/provisioning/api/v1.0/instances/{instanceId}/line-items/{lineItemId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Line item was successfully un-mapped from the instance.

Rules of Access

APIs to manage rules of access for Dynamic Monetization instances. Rules of access are used to control the way the counts of an elastic line item are used in an access request.

Operations

Rate Tables

APIs to manage rate tables. Rate tables are used to define the price of items (how many tokens are charged per item).

Operations

Sessions

APIs for elastic access within the context of a session.

Operations

Non-Session Access Request

APIs for elastic access without a session.

Operations

Configuration

APIs for managing configuration values that control how customers can access and consume line items.

Available values:

  • timezone.tolerant
    • Allows a line item to be used up to 12 hours before its start date (UTC) and up to 12 hours after its end date (UTC), therefore making it tolerant to all time zones.
    • Supported values: true (enabled) and false (disabled).
    • Default: false
Operations