v1

latestOpenAPI 3.0.02026-07-263403911.5 MB

UsagePlans

View usage plan

Find a single usage plan by ID.

get/v1/UsagePlans/{id}

idinteger required

ID of the usage plan to view.

okboolean

plan_idinteger

Primary identifier for this usage plan.

descriptionstring required

Short description (i.e. the name).

rate_method'STANDARD' | 'MARGIN' | 'MARKUP'

Rate calculation method for this plan.

activeboolean

Indicates whether the plan can be assigned.

created_datestring date-time

Date and time this plan was created.

created_byinteger

Foreign identifier indicating which user created it.