顧客 (Customers)

顧客資料與自助管理入口。

顧客通常在完成 Hosted Checkout 時自動建立，你也可以直接用 API 建立。顧客可以透過 /portal/{customerId} 的 magic-link 流程自助管理自己的訂閱、付款方式——這是產品既有機制，目前沒有對應的開發者 API（例如沒有後端可以直接生成 Portal session 的端點），magic-link 驗證仍需要顧客自己輸入 email。

GET/api/Customer— 列出顧客

屬性	值
所需權限	`customers:read`
Idempotency-Key	不需要

參數	位置	型別
`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— 建立一個新顧客

屬性	值
所需權限	`customers:write`
Idempotency-Key	不需要

參數	位置	型別
`email`	body	string (email)
`externalId`	body	string
`metadata`	body	object
`name`	body	string
`status`	body	string

GET/api/Customer/{customerId}— 讀取單一顧客

屬性	值
所需權限	`customers:read`
Idempotency-Key	不需要

參數	位置	型別	必填
`customerId`	path	string	必填

PUT/api/Customer/{customerId}— 更新顧客資料

屬性	值
所需權限	`customers:write`
Idempotency-Key	不需要

參數	位置	型別	必填
`customerId`	path	string	必填
`email`	body	string (email)
`externalId`	body	string
`metadata`	body	object
`name`	body	string
`status`	body	string

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

屬性	值
所需權限	`customers:read`
Idempotency-Key	不需要

參數	位置	型別	必填
`customerId`	path	string	必填
`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。

屬性	值
所需權限	`customers:write`
Idempotency-Key	不需要

參數	位置	型別	必填
`customerId`	path	string	必填

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

屬性	值
所需權限	`customers:write`
Idempotency-Key	不需要

參數	位置	型別	必填
`customerId`	path	string	必填

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

屬性	值
所需權限	`entitlements:write`
Idempotency-Key	不需要

參數	位置	型別	必填
`customerId`	path	string	必填
`allowed`	body	string
`limit`	body	integer (int32)
`limitAmount`	body	integer (int32)

GET/api/Customer/{customerId}/PaymentMethod— 列出顧客已儲存的付款方式參照

屬性	值
所需權限	`payments:read`
Idempotency-Key	不需要

參數	位置	型別	必填
`customerId`	path	string	必填
`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) →