Schema2020-08-27object

usage_record_summary

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

UsageRecordSummary

object

id string

required

Unique identifier for the object.

maxLength:5000

invoice string

optionalnullable

The invoice in which this usage period has been billed for.

maxLength:5000

livemode boolean

required

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

object string

required

String representing the object's type. Objects of the same type share the same value.

Allowed: "usage_record_summary"

period Period object

required

subscription_item string

required

The ID of the subscription item this summary is describing.

maxLength:5000

total_usage integer

required

The total usage within this usage period.

Root JSON Schema

{"properties":{"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"invoice":{"description":"The invoice in which this usage period has been billed for.","maxLength":5000,"nullable":true,"type":"string"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["usage_record_summary"],"type":"string"},"period":{"$ref":"#/components/schemas/period"},"subscription_item":{"description":"The ID of the subscription item this summary is describing.","maxLength":5000,"type":"string"},"total_usage":{"description":"The total usage within this usage period.","type":"integer"}},"required":["id","livemode","object","period","subscription_item","total_usage"],"title":"UsageRecordSummary","type":"object","x-expandableFields":["period"],"x-resourceId":"usage_record_summary"}