Subscription Usage¶
ComputeStacks will automatically aggregate this data at the end of the month. You may elect to receive that data as a webhook, configured under Advanced Settings in the admin.
List Usage Items¶
Description | Endpoint |
---|---|
Find via subscription | GET /admin/subscriptions/{subscription_id}/billing_usages |
Find all by user | GET /admin/users/{user_id)/billing_usages |
Schema
billing_usages
: Arrayid
: Integerperiod_start
: DateTimeperiod_end
: DateTimeexternal_id
: Stringrate
: Decimalqty
: Decimal - Billable QTY (less what would be included in their package)qty_total
: Decimal - Total QTY recordedtotal
: Decimalprocessed
: Booleanprocessed_on
: DateTimecreated_at
: DateTimeupdated_at
: DateTimesubscription_product
: Objectid
: Integerexternal_id
: Stringstart_on
: DateTimeactive
: Booleanphase_type
: Stringcreated_at
: DateTimeupdated_at
: DateTimeproduct
: Objectid
: Integerlabel
: Stringresource_kind
unit
: Stringunit_type
: Stringexternal_id
: DateTimepackage
: Objectid
: Integercpu
: Decimalmemory
: Integerstorage
: Integerbandwidth
: Integerlocal_disk
: Integermemory_swap
: Integermemory_swappiness
: Integerbackup
: Integer
user
: Objectid
: Integerfull_name
: Stringemail
: Stringexternal_id
: Stringlabels
: Object
View Usage Item¶
GET /admin/subscriptions/{subscription_id}/billing_usages/{id}
Schema
billing_usages
: Objectid
: Integerperiod_start
: DateTimeperiod_end
: DateTimeexternal_id
: Stringrate
: Decimalqty
: Decimal - Billable QTY (less what would be included in their package)qty_total
: Decimal - Total QTY recordedtotal
: Decimalprocessed
: Booleanprocessed_on
: DateTimecreated_at
: DateTimeupdated_at
: DateTimesubscription_product
: Objectid
: Integerexternal_id
: Stringstart_on
: DateTimeactive
: Booleanphase_type
: Stringcreated_at
: DateTimeupdated_at
: DateTimeproduct
: Objectid
: Integerlabel
: Stringresource_kind
unit
: Stringunit_type
: Stringexternal_id
: DateTimepackage
: Objectid
: Integercpu
: Decimalmemory
: Integerstorage
: Integerbandwidth
: Integerlocal_disk
: Integermemory_swap
: Integermemory_swappiness
: Integerbackup
: Integer
user
: Objectid
: Integerfull_name
email
: Stringexternal_id
: Stringlabels
: Object
Delete Usage Item¶
DELETE /admin/subscriptions/{subscription_id}/billing_usages/{id}
Last update: 2021-12-31