Billing Period
Returns the active billing period for the authenticated workspace, plus billing type, plan, and included credits.
GET https://api.platica.mx/v1/usage/periodQuery parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
workspace | string | Filters the response to one workspace. If omitted, returns all accessible workspaces | — |
Response
{
"workspaces": [
{
"id": "g6yCA16pkWl5eXo7KszB",
"name": "My company",
"usagePeriod": {
"billingType": "subscription",
"plan": {
"name": "Growth",
"credits": 6500
},
"billingPeriod": {
"startDate": "2026-06-01T00:00:00.000Z",
"endDate": "2026-06-30T23:59:59.999Z"
},
"resetDate": "2026-06-30T23:59:59.999Z",
"dataSince": "2026-05-21T06:00:00.000Z"
}
}
],
"workspacesCount": 1
}Response fields
| Field | Description |
|---|---|
id | Workspace ID |
name | Workspace name |
usagePeriod.billingType | Billing type: trial, free, subscription, or enterprise |
usagePeriod.plan.name | Plan name. For enterprise workspaces it is enterprise |
usagePeriod.plan.credits | Included credits configured for the workspace |
usagePeriod.billingPeriod | Active window used to measure consumption (startDate and endDate) |
usagePeriod.resetDate | Date when the current period ends |
usagePeriod.dataSince | Earliest reliable date for billable metrics |
workspacesCount | Total workspaces returned |
Nota
For enterprise workspaces, plan.name is enterprise and plan.credits reflects the credits configured for the workspace.