Interface: PayPeriod

Defined in: me-client/src/pay-periods.ts:13

When a project pays its users. Paying is optional: a project may pay always, only in promos, or never. A pay period is a stretch of time in which its events earn its users sats; outside every period an event earns and costs nothing, and me.ochk.io records nothing.

GET /api/integrator/config returns a project's pay_periods, past ones included. Periods that have started never change, so any earning can be checked against the period that paid it. Mirrors me.ochk.io's lib/events/pay-periods.ts.

Properties

Property	Type	Description	Defined in
<a id="property-ends_at"></a> `ends_at`	`string` \| `null`	When it stops, or null: until the project turns it off.	me-client/src/pay-periods.ts:20
<a id="property-id"></a> `id`	`string`	-	me-client/src/pay-periods.ts:14
<a id="property-name"></a> `name`	`string`	A promo's name ("Launch week"); empty for plain paying.	me-client/src/pay-periods.ts:16
<a id="property-starts_at"></a> `starts_at`	`string`	When paying starts, ISO-8601 UTC.	me-client/src/pay-periods.ts:18