Skip to main content
POST
/
subscriptions
/
usage
Get usage by subscription
curl --request POST \
  --url https://us.api.flexprice.io/v1/subscriptions/usage \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "subscription_id": "123",
  "end_time": "2024-03-20T00:00:00Z",
  "lifetime_usage": false,
  "start_time": "2024-03-13T00:00:00Z"
}
'
{
  "amount": 123,
  "charges": [
    {
      "amount": 123,
      "currency": "<string>",
      "display_amount": "<string>",
      "filter_values": {},
      "is_overage": true,
      "meter_display_name": "<string>",
      "meter_id": "<string>",
      "overage_factor": 123,
      "price": {
        "amount": "<string>",
        "billing_period_count": 123,
        "conversion_rate": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "currency": "<string>",
        "description": "<string>",
        "display_amount": "<string>",
        "display_name": "<string>",
        "display_price_unit_amount": "<string>",
        "end_date": "2023-11-07T05:31:56Z",
        "entity_id": "<string>",
        "environment_id": "<string>",
        "group_id": "<string>",
        "id": "<string>",
        "lookup_key": "<string>",
        "metadata": {},
        "meter_id": "<string>",
        "min_quantity": "<string>",
        "parent_price_id": "<string>",
        "price_unit": "<string>",
        "price_unit_amount": "<string>",
        "price_unit_id": "<string>",
        "price_unit_tiers": [
          {
            "flat_amount": "<string>",
            "unit_amount": "<string>",
            "up_to": 123
          }
        ],
        "start_date": "2023-11-07T05:31:56Z",
        "tenant_id": "<string>",
        "tiers": [
          {
            "flat_amount": "<string>",
            "unit_amount": "<string>",
            "up_to": 123
          }
        ],
        "transform_quantity": {
          "divide_by": 123
        },
        "trial_period_days": 123,
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      },
      "quantity": 123,
      "subscription_line_item_id": "<string>"
    }
  ],
  "commitment_amount": 123,
  "commitment_utilized": 123,
  "currency": "<string>",
  "display_amount": "<string>",
  "end_time": "2023-11-07T05:31:56Z",
  "has_overage": true,
  "overage_amount": 123,
  "overage_factor": 123,
  "start_time": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.flexprice.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Usage request

​
subscription_id
string
required
Example:

"123"

​
end_time
string<date-time>
Example:

"2024-03-20T00:00:00Z"

​
lifetime_usage
boolean
Example:

false

​
start_time
string<date-time>
Example:

"2024-03-13T00:00:00Z"

Response

OK

​
amount
number
​
charges
object[]
​
commitment_amount
number
​
commitment_utilized
number

Amount of commitment used

​
currency
string
​
display_amount
string
​
end_time
string<date-time>
​
has_overage
boolean

Whether any usage exceeded commitment

​
overage_amount
number

Amount charged at overage rate

​
overage_factor
number
​
start_time
string<date-time>