Open period

POST

/billing/billing_ledger_periods/open/v1/:billing_ledger_id

Opens a new period on an ACTIVE billing ledger. Operator supplies cycle, rate_usd, and at least one of (period_start_at_timestamp, period_end_at_timestamp) — the other is derived from cycle (calendar-aware). A period spans exactly one cycle. Multiple OPEN periods per ledger are allowed and may overlap. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_owner_operators] | (OpenPeriodReq) -> (PydanticObjectId)

Opens a new period on an ACTIVE billing ledger. Operator supplies `cycle`, `rate_usd`, and at least one of `(period_start_at_timestamp, period_end_at_timestamp)` — the other is derived from `cycle` (calendar-aware). A period spans exactly one cycle. Multiple OPEN periods per ledger are allowed and may overlap. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_owner_operators] | (OpenPeriodReq) -> (PydanticObjectId)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

billing_ledger_idstringRequired

Request

This endpoint expects an object.

cycleenumRequired

Allowed values:

rate_usddoubleRequired

period_start_at_timestampdatetimeOptional

period_end_at_timestampdatetimeOptional

Response

Successful Response

Errors

422

Billing Ledger Periods Open V1request Unprocessable Entity Error

1	import { ChrtClient } from "@chrt-inc/typescript-sdk";
2
3	async function main() {
4	const client = new ChrtClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.billing.billingLedgerPeriods.openV1("billing_ledger_id", {
8	cycle: "monthly",
9	rate_usd: 1500.75,
10	});
11	}
12	main();