Charging periods

List, create, read, update and delete charging periods, each linked to a time period by its tp_ id.

A charging period is a settings record linked to a time period. You can list, create, read, update and delete charging periods. This area has 5 endpoints, and all seven SDKs call every one.

At a glance

Endpoint	Method	Path	What it does
List charging periods	GET	/settings/charging_periods	Returns a page of charging periods under data, with paging details under pagination.
Create a charging period	POST	/settings/charging_periods	Creates a charging period and returns it under charging_period.
Retrieve a charging period	GET	/settings/charging_periods/{charging_period_id}	Returns one charging period by its id, under charging_period.
Delete a charging period	DELETE	/settings/charging_periods/{charging_period_id}	Deletes a charging period. The response has no body.
Update a charging period	PATCH	/settings/charging_periods/{charging_period_id}	Changes the fields you send on a charging period and returns it under charging_period.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• name, display_name and time_period are required on a create. time_period is the time period’s tp_ id.
• A read returns time_period as an object. It holds the time period’s id, name, object and href.
• A charging period id starts with cp_.
• Listings page by cursor. Records sit under data; pass pagination.next_cursor as cursor to read the next page, and stop when pagination.has_more is false.
• A delete returns 204 with no body. Reading the charging period afterwards returns 404.