Customers

Customer data and their self-service entry point.

Customers are usually created automatically when a Hosted Checkout completes, or you can create one directly via the API. Customers self-manage their subscription and payment methods through the /portal/{customerId} magic-link flow — this is an existing product mechanism with no corresponding developer API today (there's no server-to-server endpoint to mint a Portal session); magic-link verification still requires the customer to enter their own email.

GET/api/Customer— List customers

Property	Value
Required scope	`customers:read`
Idempotency-Key	Not required

Parameter	In	Type
`page`	query	integer (int32)
`pageSize`	query	integer (int32)
`orderBy`	query	string
`orderDirection`	query	string
`createdFrom`	query	string (date-time)
`createdTo`	query	string (date-time)

POST/api/Customer— Create a new customer

Property	Value
Required scope	`customers:write`
Idempotency-Key	Not required

Parameter	In	Type
`email`	body	string (email)
`externalId`	body	string
`metadata`	body	object
`name`	body	string
`status`	body	string

GET/api/Customer/{customerId}— Retrieve a single customer

Property	Value
Required scope	`customers:read`
Idempotency-Key	Not required

Parameter	In	Type	Required
`customerId`	path	string	Required

PUT/api/Customer/{customerId}— Update a customer

Property	Value
Required scope	`customers:write`
Idempotency-Key	Not required

Parameter	In	Type	Required
`customerId`	path	string	Required
`email`	body	string (email)
`externalId`	body	string
`metadata`	body	object
`name`	body	string
`status`	body	string

GET/api/Customer/{customerId}/CustomValue— 顧客：CustomValue。

Property	Value
Required scope	`customers:read`
Idempotency-Key	Not required

Parameter	In	Type	Required
`customerId`	path	string	Required
`page`	query	integer (int32)
`pageSize`	query	integer (int32)
`orderBy`	query	string
`orderDirection`	query	string
`createdFrom`	query	string (date-time)
`createdTo`	query	string (date-time)

POST/api/Customer/{customerId}/CustomValue— 顧客：CustomValue。

Property	Value
Required scope	`customers:write`
Idempotency-Key	Not required

Parameter	In	Type	Required
`customerId`	path	string	Required

PUT/api/Customer/{customerId}/CustomValue— 顧客：CustomValue。

Property	Value
Required scope	`customers:write`
Idempotency-Key	Not required

Parameter	In	Type	Required
`customerId`	path	string	Required

POST/api/Customer/{customerId}/EntitlementOverride— 顧客：EntitlementOverride。

Property	Value
Required scope	`entitlements:write`
Idempotency-Key	Not required

Parameter	In	Type	Required
`customerId`	path	string	Required
`allowed`	body	string
`limit`	body	integer (int32)
`limitAmount`	body	integer (int32)

GET/api/Customer/{customerId}/PaymentMethod— List a customer's saved payment method refs

Property	Value
Required scope	`payments:read`
Idempotency-Key	Not required

Parameter	In	Type	Required
`customerId`	path	string	Required
`page`	query	integer (int32)
`pageSize`	query	integer (int32)
`orderBy`	query	string
`orderDirection`	query	string
`createdFrom`	query	string (date-time)
`createdTo`	query	string (date-time)

← Prices Subscriptions →