Skip to main content
GET
Retrieve customer

Authorizations

Authorization
string
header
required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

x-simple-workspace
string
required

Workspace (account) identifier. Required for every request.

x-piriod-test-mode
boolean
default:false

Whether to operate against test-mode data. Defaults to false.

Path Parameters

id
string
required

Resource identifier.

Response

The customer.

name
string
required
Maximum string length: 100
address
string
required
Maximum string length: 64
country
object
required
state
object
required
id
string
read-only
Example:

"cus_01H8XYZ123ABC"

currency
string

ISO currency code (e.g. CLP, USD).

Example:

"CLP"

email
string<email> | null
phone
string | null
Maximum string length: 16
website
string<uri> | null
zip_code
string | null
Maximum string length: 16
manager
string | null

Account manager name (free text).

Maximum string length: 64
reference
string | null

External reference for the customer.

Maximum string length: 64
tax_id
string | null

Tax identifier. Required when the customer's country has tax regulation (e.g. Chile RUT, Mexico RFC, Colombia NIT) and matches the account's country.

Maximum string length: 32
tax_settings
object

Country-specific tax configuration. Schema and required keys depend on the tax agency of the customer's country.

metadata
object

Arbitrary key/value metadata. Filterable via ?metadata__key=value.

send_invoices
boolean
default:true

Whether to email invoices to the customer.

send_collections
boolean
default:true

Whether to email collection reminders to the customer.

send_vouchers
boolean
default:true

Whether to email payment receipts to the customer.

status
enum<string>
default:active
Available options:
active,
archived,
pending
contacts
object[]
read-only
sources
string[]
read-only

IDs of reusable payment sources currently chargeable or pending.

aggregations
object
test_mode
boolean
read-only
created
string<date-time>
read-only
updated
string<date-time>
read-only