aria-partner-api

Product API

A member can hold many of these products. Subscription seats you have already purchased (available, occupied) are on GET /api/v1/seats/. Unassigned on-demand credits are on GET /api/v1/credits/. Assign product ids from this catalog with product_ids on POST /api/v1/accounts/ or POST /api/v1/members/{member_id}/product/.

Resource Path Purpose
Products /api/v1/products/ GET the products available for consumption
Product /api/v1/products/{product_id}/ GET one product and its description

Auth: Bearer token required. See Authentication.

Products

Subscriptions: Core, Advanced, Trial

On demand: Core Scan, Advanced Scan, Trial Scan

List products

GET /api/v1/products/

Returns every product your partner can consume, with a description of what it does.

Example

GET /api/v1/products/
Authorization: Bearer <api_key>

Success (200 OK)

{
  "results": [
    {
      "product_id": 101,
      "product_name": "Core",
      "description": "Scan and removal subscription on the Core catalog.",
      "charge_type": "subscription",
      "billing_frequency": "monthly",
      "price_per_seat": 999
    }
  ]
}
Field Type Description
results array Products available for consumption

Each object in results:

Field Type Description
product_id integer Pass as an id in product_ids on account create, or when adding a product
product_name string "Core", "Advanced", "Trial", "Core Scan", "Advanced Scan", or "Trial Scan"
description string What the product includes
charge_type string "subscription" or "on_demand"
billing_frequency string "monthly", "annually", or "one_time"
price_per_seat integer Price per seat or credit in cents

Errors

Status Condition
401 Missing or invalid API key
403 Partner inactive

Retrieve one product

GET /api/v1/products/{product_id}/

Same object as one entry in results.

Example

GET /api/v1/products/101/
Authorization: Bearer <api_key>

Success (200 OK)

{
  "product_id": 101,
  "product_name": "Core",
  "description": "Scan and removal subscription on the Core catalog.",
  "charge_type": "subscription",
  "billing_frequency": "monthly",
  "price_per_seat": 999
}

Errors

Status Condition
401 Missing or invalid API key
403 Partner inactive
404 Product not found or not offered to your partner