API Reference

customer-created

webhook
customer-created

Webhook to notify when a customer is created.

Payload
uuid
required
date-time
required

ISO 8601 timestamp in UTC timezone (must end with 'Z')

metadata
object

Customer metadata values keyed by metadata definition key.

uuid | null

The family this customer belongs to. Set through the customer-families endpoints, not here.

uuid | null

The member this customer reports to within its family. The family's root parent reports to no one.

string
required
string
address
object
shipping_address
object
emails
array of objects, unique
emails
external_references
array of objects, unique
external_references
int32
≥ 0
boolean
Defaults to false

When set to true, invoices for this customer will be automatically sent via email on the invoice date.

boolean
Defaults to false

When set to true, an email will be sent to customers periodically if they have not paid an invoice.

boolean

Allows this customer to pay invoices online via Stripe, and must be true before auto-payment can be set up for them. Omit on create to leave online payments off; omit on update to keep the customer's current setting. Enabling it requires Stripe to be configured for at least one subsidiary.

fields
array of objects | null
fields
Headers
string
required

Signature of the webhook event. Computed using HMAC-SHA256 and AES encrypted with the configured webhook token. The contents of the body are prefixed with the timestamp and id before hashing.

date-time
required

Timestamp of the webhook event in ISO-8601 format

uuid
required

ID of the webhook event

string
required

Entity type of the webhook event

string
required

Event type of the webhook event

Response

Updated 5 months ago

Did this page help you?
LoadingLoading…

Updated 5 months ago

Did this page help you?