Get expected usage for current month

cloud

GET 
/v2/organizations/:organizationId/billing/expected-usage

Get expected usage for current month

Request

Path Parameters

organizationId int64required

Responses

200

OK

application/json

Schema

Schema

subscriptionPrice number
appliedStripeCredits number

Relevant for invoices only. When there are applied stripe credits, we need to reduce the total price by this amount.

seats objectrequired
total numberrequired
unusedQuantity numberrequired
usedQuantity numberrequired
usedQuantityOverPlan numberrequired
translations objectrequired
total numberrequired
unusedQuantity numberrequired
usedQuantity numberrequired
usedQuantityOverPlan numberrequired
credits object
total numberrequired
unusedQuantity int64required
usedQuantity int64required
usedQuantityOverPlan int64required
total numberrequired

Example (from schema)

{
  "subscriptionPrice": 0,
  "appliedStripeCredits": 0,
  "seats": {
    "total": 0,
    "unusedQuantity": 0,
    "usedQuantity": 0,
    "usedQuantityOverPlan": 0
  },
  "translations": {
    "total": 0,
    "unusedQuantity": 0,
    "usedQuantity": 0,
    "usedQuantityOverPlan": 0
  },
  "credits": {
    "total": 0,
    "unusedQuantity": 0,
    "usedQuantity": 0,
    "usedQuantityOverPlan": 0
  },
  "total": 0
}

400

Bad Request

*/*

Schema

Schema

string

401

Unauthorized

*/*

Schema

Schema

string

403

Forbidden

*/*

Schema

Schema

string

404

Not Found

*/*

Schema

Schema

string

Loading...