Octane · JSON-LD Context

Octane Context

JSON-LD context defining the semantic vocabulary for Octane from Octane.

20 Classes 101 Properties 3 Namespaces

View Context View on GitHub

Namespaces

octane: https://www.getoctane.io/ns#

schema: https://schema.org/

xsd: http://www.w3.org/2001/XMLSchema#

Classes

Meter Measurement Customer PricePlan MeteredComponent PriceScheme PriceTier ActiveSubscription Invoice Feature AddOn Limit Trial Coupon Webhook CreditGrant CreditTopOffPlan AdhocCharge BillingSettings ContactInfo

Properties

Property	Type	Container
name	string
display_name	string
description	string
created_at	dateTime
event_name	string
meter_name	string
meter_type	string
data_type	string
aggregation	string
unit_name	string
is_incremental	boolean
reporting_method	string
expected_labels		list
primary_labels		list
event_label_filter
value
time	dateTime
labels
reset_total	boolean
customer_name	string
period	string
base_price	decimal
base_price_frequency	string
base_price_description	string
minimum_charge	decimal
minimum_charge_frequency	string
metered_components		set
features		set
add_ons		set
limits		set
trial
price_scheme
scheme_type	string
prices		list
price	decimal
cap	decimal
watermark	decimal
price_plan
price_plan_name	string
price_plan_uuid	string
effective_at	dateTime
expired_at	dateTime
align_to_calendar	boolean
current_billing_cycle
discounts		set
features_override		set
limits_override		set
trial_override
credit_plan
uuid	string
status	string
issue_date	dateTime
due_date	dateTime
sub_total	decimal
tax_amount	decimal
pdf_url	anyURI
line_items		list
discount_type	string
discount_amount	decimal
frequency	string
duration_length	integer
duration_unit	string
expiration_time	dateTime
max_uses	integer
code	string
url	anyURI
enable_signature	boolean
amount	decimal
available_balance	decimal
threshold	decimal
top_off_amount	decimal
enabled	boolean
address_line_1	string
address_line_2	string
city	string
state	string
country	string
zipcode	string
email	string
phone	string
legal_name	string
vat_id	string
time_length	integer
time_unit_name	string
credit	decimal
single_use	boolean
quantity_enabled	boolean
immediately_charge	boolean
price_frequency	string
charge_frequency	string
measurement_mappings		set
label	string
has_access	boolean
current_usage	decimal
limit	decimal
contact_info
auto_charge	boolean
invoice_grace_period_days	integer
payment_gateway_type	string
external_uuid	string
vendor_id	string

JSON-LD Document

{
  "@context": {
    "@version": 1.1,
    "octane": "https://www.getoctane.io/ns#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",

    "Meter": "octane:Meter",
    "Measurement": "octane:Measurement",
    "Customer": "octane:Customer",
    "PricePlan": "octane:PricePlan",
    "MeteredComponent": "octane:MeteredComponent",
    "PriceScheme": "octane:PriceScheme",
    "PriceTier": "octane:PriceTier",
    "ActiveSubscription": "octane:ActiveSubscription",
    "Invoice": "octane:Invoice",
    "Feature": "octane:Feature",
    "AddOn": "octane:AddOn",
    "Limit": "octane:Limit",
    "Trial": "octane:Trial",
    "Coupon": "octane:Coupon",
    "Webhook": "octane:Webhook",
    "CreditGrant": "octane:CreditGrant",
    "CreditTopOffPlan": "octane:CreditTopOffPlan",
    "AdhocCharge": "octane:AdhocCharge",
    "BillingSettings": "octane:BillingSettings",
    "ContactInfo": "octane:ContactInfo",

    "name": { "@id": "schema:name", "@type": "xsd:string" },
    "display_name": { "@id": "octane:displayName", "@type": "xsd:string" },
    "description": { "@id": "schema:description", "@type": "xsd:string" },
    "created_at": { "@id": "schema:dateCreated", "@type": "xsd:dateTime" },

    "event_name": { "@id": "octane:eventName", "@type": "xsd:string" },
    "meter_name": { "@id": "octane:meterName", "@type": "xsd:string" },
    "meter_type": { "@id": "octane:meterType", "@type": "xsd:string" },
    "data_type": { "@id": "octane:dataType", "@type": "xsd:string" },
    "aggregation": { "@id": "octane:aggregation", "@type": "xsd:string" },
    "unit_name": { "@id": "octane:unitName", "@type": "xsd:string" },
    "is_incremental": { "@id": "octane:isIncremental", "@type": "xsd:boolean" },
    "reporting_method": { "@id": "octane:reportingMethod", "@type": "xsd:string" },
    "expected_labels": { "@id": "octane:expectedLabels", "@container": "@list" },
    "primary_labels": { "@id": "octane:primaryLabels", "@container": "@list" },
    "event_label_filter": { "@id": "octane:eventLabelFilter" },

    "value": { "@id": "schema:value" },
    "time": { "@id": "schema:startTime", "@type": "xsd:dateTime" },
    "labels": { "@id": "octane:labels" },
    "reset_total": { "@id": "octane:resetTotal", "@type": "xsd:boolean" },
    "customer_name": { "@id": "octane:customerName", "@type": "xsd:string" },

    "period": { "@id": "octane:period", "@type": "xsd:string" },
    "base_price": { "@id": "octane:basePrice", "@type": "xsd:decimal" },
    "base_price_frequency": { "@id": "octane:basePriceFrequency", "@type": "xsd:string" },
    "base_price_description": { "@id": "octane:basePriceDescription", "@type": "xsd:string" },
    "minimum_charge": { "@id": "octane:minimumCharge", "@type": "xsd:decimal" },
    "minimum_charge_frequency": { "@id": "octane:minimumChargeFrequency", "@type": "xsd:string" },
    "metered_components": { "@id": "octane:meteredComponents", "@container": "@set" },
    "features": { "@id": "octane:features", "@container": "@set" },
    "add_ons": { "@id": "octane:addOns", "@container": "@set" },
    "limits": { "@id": "octane:limits", "@container": "@set" },
    "trial": { "@id": "octane:trial" },

    "price_scheme": { "@id": "octane:priceScheme" },
    "scheme_type": { "@id": "octane:schemeType", "@type": "xsd:string" },
    "prices": { "@id": "octane:prices", "@container": "@list" },
    "price": { "@id": "schema:price", "@type": "xsd:decimal" },
    "cap": { "@id": "octane:cap", "@type": "xsd:decimal" },
    "watermark": { "@id": "octane:watermark", "@type": "xsd:decimal" },

    "price_plan": { "@id": "octane:pricePlan" },
    "price_plan_name": { "@id": "octane:pricePlanName", "@type": "xsd:string" },
    "price_plan_uuid": { "@id": "octane:pricePlanUuid", "@type": "xsd:string" },
    "effective_at": { "@id": "octane:effectiveAt", "@type": "xsd:dateTime" },
    "expired_at": { "@id": "octane:expiredAt", "@type": "xsd:dateTime" },
    "align_to_calendar": { "@id": "octane:alignToCalendar", "@type": "xsd:boolean" },
    "current_billing_cycle": { "@id": "octane:currentBillingCycle" },
    "discounts": { "@id": "octane:discounts", "@container": "@set" },
    "features_override": { "@id": "octane:featuresOverride", "@container": "@set" },
    "limits_override": { "@id": "octane:limitsOverride", "@container": "@set" },
    "trial_override": { "@id": "octane:trialOverride" },
    "credit_plan": { "@id": "octane:creditPlan" },

    "uuid": { "@id": "schema:identifier", "@type": "xsd:string" },
    "status": { "@id": "schema:status", "@type": "xsd:string" },
    "issue_date": { "@id": "octane:issueDate", "@type": "xsd:dateTime" },
    "due_date": { "@id": "octane:dueDate", "@type": "xsd:dateTime" },
    "sub_total": { "@id": "octane:subTotal", "@type": "xsd:decimal" },
    "tax_amount": { "@id": "octane:taxAmount", "@type": "xsd:decimal" },
    "pdf_url": { "@id": "schema:url", "@type": "xsd:anyURI" },
    "line_items": { "@id": "octane:lineItems", "@container": "@list" },

    "discount_type": { "@id": "octane:discountType", "@type": "xsd:string" },
    "discount_amount": { "@id": "octane:discountAmount", "@type": "xsd:decimal" },
    "frequency": { "@id": "octane:frequency", "@type": "xsd:string" },
    "duration_length": { "@id": "octane:durationLength", "@type": "xsd:integer" },
    "duration_unit": { "@id": "octane:durationUnit", "@type": "xsd:string" },
    "expiration_time": { "@id": "octane:expirationTime", "@type": "xsd:dateTime" },
    "max_uses": { "@id": "octane:maxUses", "@type": "xsd:integer" },
    "code": { "@id": "octane:code", "@type": "xsd:string" },

    "url": { "@id": "schema:url", "@type": "xsd:anyURI" },
    "enable_signature": { "@id": "octane:enableSignature", "@type": "xsd:boolean" },

    "amount": { "@id": "schema:amount", "@type": "xsd:decimal" },
    "available_balance": { "@id": "octane:availableBalance", "@type": "xsd:decimal" },
    "threshold": { "@id": "octane:threshold", "@type": "xsd:decimal" },
    "top_off_amount": { "@id": "octane:topOffAmount", "@type": "xsd:decimal" },
    "enabled": { "@id": "octane:enabled", "@type": "xsd:boolean" },

    "address_line_1": { "@id": "schema:streetAddress", "@type": "xsd:string" },
    "address_line_2": { "@id": "octane:addressLine2", "@type": "xsd:string" },
    "city": { "@id": "schema:addressLocality", "@type": "xsd:string" },
    "state": { "@id": "schema:addressRegion", "@type": "xsd:string" },
    "country": { "@id": "schema:addressCountry", "@type": "xsd:string" },
    "zipcode": { "@id": "schema:postalCode", "@type": "xsd:string" },
    "email": { "@id": "schema:email", "@type": "xsd:string" },
    "phone": { "@id": "schema:telephone", "@type": "xsd:string" },
    "legal_name": { "@id": "schema:legalName", "@type": "xsd:string" },
    "vat_id": { "@id": "schema:vatID", "@type": "xsd:string" },

    "time_length": { "@id": "octane:timeLength", "@type": "xsd:integer" },
    "time_unit_name": { "@id": "octane:timeUnitName", "@type": "xsd:string" },
    "credit": { "@id": "octane:credit", "@type": "xsd:decimal" },

    "single_use": { "@id": "octane:singleUse", "@type": "xsd:boolean" },
    "quantity_enabled": { "@id": "octane:quantityEnabled", "@type": "xsd:boolean" },
    "immediately_charge": { "@id": "octane:immediatelyCharge", "@type": "xsd:boolean" },
    "price_frequency": { "@id": "octane:priceFrequency", "@type": "xsd:string" },
    "charge_frequency": { "@id": "octane:chargeFrequency", "@type": "xsd:string" },

    "measurement_mappings": { "@id": "octane:measurementMappings", "@container": "@set" },
    "label": { "@id": "octane:label", "@type": "xsd:string" },
    "has_access": { "@id": "octane:hasAccess", "@type": "xsd:boolean" },
    "current_usage": { "@id": "octane:currentUsage", "@type": "xsd:decimal" },
    "limit": { "@id": "octane:limit", "@type": "xsd:decimal" },

    "contact_info": { "@id": "octane:contactInfo" },
    "auto_charge": { "@id": "octane:autoCharge", "@type": "xsd:boolean" },
    "invoice_grace_period_days": { "@id": "octane:invoiceGracePeriodDays", "@type": "xsd:integer" },
    "payment_gateway_type": { "@id": "octane:paymentGatewayType", "@type": "xsd:string" },
    "external_uuid": { "@id": "octane:externalUuid", "@type": "xsd:string" },
    "vendor_id": { "@id": "octane:vendorId", "@type": "xsd:string" }
  }
}