Customer information and Usage record API

API's for getting customer information and sending the usage record

PriceOps API is organized around REST.

Here is what you need to GET customer information and POST usage records

Base URL

https://engine.prod.priceops.net/api

Authentication

Authentication

curl'https://engine.prod.priceops.net/api/v1/integration/organization/{ORG_ID}' \
'Authorization: {API_KEY}'

Endpoints

To get all customers that have subscribed to your plans, the corresponding plans they have subscribed to, and the resources they are using.

The resources are based on the price metrics you have chosen to publish prices.

Customer Endpoint

GET /v1/integration/organization/{ORG_ID}/customers' \

Typical response looks like below:

Response

{
        "customer_id": "1007",
        "customer_plans": [
            {
                "product_name": "Better",
                "status": "active",
                "scenario_name": "Product Launch",
                "project_name": "New Project"
            },
            {
                "product_name": "Good_MVP",
                "status": "active",
                "scenario_name": "Product Launch",
                "project_name": "Project - MVP Launch"
            }
        ],
        "resource_list": [
            "API"
        ]
    },
    {
        "customer_id": "1008",
        "customer_plans": [
            {
                "product_name": "Better",
                "status": "active",
                "scenario_name": "Product Launch",
                "project_name": "New Project"
            },
            {
                "product_name": "Good_MVP",
                "status": "active",
                "scenario_name": "Product Launch",
                "project_name": "Project - MVP Launch"
            }
        ],
        "resource_list": [
            "API"
        ]
}

Usage record for each customer

Usage Endpoint

POST /v1/integration/organization/{ORG_ID}/usage' \

Usage record API


{
    "usage_record_id" : "123457", //distinct usage_record ID
    "customer_id" : "1008", // customer_ID in your system
    "usage_data" : [
        {
            "resource" : "API", //from the response in the previous GET response
            "quantity" : 5000 //usage quantity for the day or period you select
        }
    ]
}

You can find your ORG_ID and your API_KEY in the organization page in PriceOps.

Here's an example:

PreviousCustomer login flow

Last updated 1 year ago

{ "customer_id": "1007", "customer_plans": [ { "product_name": "Better", "status": "active", "scenario_name": "Product Launch", "project_name": "New Project" }, { "product_name": "Good_MVP", "status": "active", "scenario_name": "Product Launch", "project_name": "Project - MVP Launch" } ], "resource_list": [ "API" ] }, { "customer_id": "1008", "customer_plans": [ { "product_name": "Better", "status": "active", "scenario_name": "Product Launch", "project_name": "New Project" }, { "product_name": "Good_MVP", "status": "active", "scenario_name": "Product Launch", "project_name": "Project - MVP Launch" } ], "resource_list": [ "API" ] }

{ "usage_record_id" : "123457", //distinct usage_record ID "customer_id" : "1008", // customer_ID in your system "usage_data" : [ { "resource" : "API", //from the response in the previous GET response "quantity" : 5000 //usage quantity for the day or period you select } ] }