Customer(顧客)

Customers(顧客)オブジェクトは、同一の顧客に対する複数回の課金を可能にします。 このAPIによって、顧客の作成、削除、更新ができるようになります。 その他にも、特定の顧客の情報を取得したり、顧客一覧のリストを取得したりすることができます。

Attribute

Name Type Description
object string

customer と返ることで、このJSONレスポンスがCustomerの内容に関連することを示す。

id object_id

Customer ID。

livemode boolean

本番モード (true) あるいはテストモード(false) customer。

location string

現在のcustomerオブジェクトを取得するためのAPIパス。

cards list

顧客にひもづくCardオブジェクトのリストが含まれます。リスト形式の詳細は ペジネーションとリストをご覧ください。 objects。

created datetime

ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)でcustomer作成の協定世界時(UTC)。

default_card object_id

Customerを用いて課金する際にデフォルトで利用されるカードのCARD_ID。 デフォルトカードはcustomerにアサインされた最初のカードとなります。デフォルトカードが削除されますと、最後に追加されたカードがデフォルトカードになります。 顧客にカードが登録されていない場合、nullの値が表示されます。

deleted boolean

customerが削除されたかどうか。

description string

解読可能なcustomerの説明。

email string

customerに関連付けられたメールアドレス。

metadata object

メタデータをカスタムする (例 {"customer-id": 42}) customer。

Example

  • Json Response

顧客リストの取得

- GET https://api.omise.co/customers

customerに属するすべての お客様のアカウントオブジェクトの list を返します。

Request Parameter

Name Type Description
offset integer

(optional、default:0) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。

limit integer

(optional, default: 20, maximum: 100) 返されたレコード数。

from datetime

(optional, default: 1970-01-01T00:00:00Z) ISO 8601 形式の返されたレコードの最初のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

to datetime

(optional, default: current UTC datetime) ISO 8601 形式で返されたレコードの最新のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

order string

(optional, default: chronological) chronological(最初のものから最新のもの)または reverse_chronological (最新のものから最初のもの)のリストのオーダーが返されます。

Example

  • 顧客リストの取得

新しい顧客の作成

- POST https://api.omise.co/customers

新しい顧客のオブジェクト情報を返します。

Request Parameter

Name Type Description
email string

任意:顧客のメールアドレス。

description string

任意:顧客の説明文。

metadata object

メタデータをカスタムする (例 {"customer-id": 42}) customer。

card object_id

任意:Token ID(カードトークン)を指定することで顧客とCardオブジェクトをひも付けることができます。

Example

  • 新しい顧客の作成

  • 新しい顧客の作成し、Cardオブジェクトをひも付ける

顧客情報の取得

- GET https://api.omise.co/customers/CUSTOMER_ID

顧客(Customer)オブジェクト作成時に返された顧客IDを指定し、既存の顧客の詳細情報を取得します。

Example

  • 顧客情報の取得

顧客情報の更新

- PATCH https://api.omise.co/customers/CUSTOMER_ID

指定した顧客の情報を必要な部分のみ更新します。更新後、その顧客オブジェクトが返されます。

Request Parameter

Name Type Description
email string

任意:顧客のメールアドレス。

description string

任意:顧客の説明文。

metadata object

メタデータをカスタムする (例 {"customer-id": 42}) customer。

default_card object_id

Customerを用いて課金する際にデフォルトで利用されるカードのCARD_ID。 デフォルトカードはcustomerにアサインされた最初のカードとなります。デフォルトカードが削除されますと、最後に追加されたカードがデフォルトカードになります。 顧客にカードが登録されていない場合、nullの値が表示されます。

card object_id

任意:Token ID(カードトークン)を指定することで顧客とCardオブジェクトをひも付けることができます。

Example

  • 顧客情報の更新

  • 顧客へカードをひも付ける

顧客の削除

- DELETE https://api.omise.co/customers/CUSTOMER_ID

顧客を永久に削除します。この操作はロールバックできませんので、慎重に行いましょう。

Example

  • 顧客の削除

  • レスポンス (JSON)