Schema2020-08-27object

recurring

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

Recurring

object

aggregate_usage string

optionalnullable

Specifies a usage aggregation strategy for prices of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.

Allowed: "last_during_period""last_ever""max""sum"

interval string

required

The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.

Allowed: "day""month""week""year"

interval_count integer

required

The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.

usage_type string

required

Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.

Allowed: "licensed""metered"

Root JSON Schema

{"properties":{"aggregate_usage":{"description":"Specifies a usage aggregation strategy for prices of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.","enum":["last_during_period","last_ever","max","sum"],"nullable":true,"type":"string"},"interval":{"description":"The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.","enum":["day","month","week","year"],"type":"string"},"interval_count":{"description":"The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.","type":"integer"},"usage_type":{"description":"Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.","enum":["licensed","metered"],"type":"string"}},"required":["interval","interval_count","usage_type"],"title":"Recurring","type":"object","x-expandableFields":[]}