Billing

Customer status snapshot

Returns a financial summary for the customer: status, total finalized sales, sales in the current month, outstanding balance and source flags.

get/customers/{id}/status/

Request

Base URL
https://api.piriod.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/piriod/apis/piriod-api/docs/customers/:id/status/get.ts
A function with typed inputs. Its response is checked against the schema.

Customer status snapshot.

status'active' | 'archived' | 'pending'

salesnumber

sales_current_periodnumber

balancenumber

has_valuable_sourcesboolean

True if the customer has reusable sources that should be preserved on archive.

has_archivable_abandoned_sourcesboolean

True if the customer has abandoned reusable sources linked to payments.

No recorded changes to this operation across all 1 revision of this API.