Customer(顧客)

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

Attributes

Name Type Description
object string

固定値customer

id string

/cust(_test)?_[0-9a-z]+/に一致するCUSTOMER_ID

livemode boolean

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

location string

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

cards list

顧客に紐づく cards(カード) のList(リスト) 。

created_at string

ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ)で顧客が作成されたUTC日時。

default_card object_id_expandable

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

deleted boolean

顧客が削除されたかどうか。

description string

顧客の説明。

email string

顧客に紐づけられたメールアドレス。

metadata object

顧客用のカスタムメタデータ(例:{"customer-id": 42}) 。

Example

  • JSON Response

新しい顧客の作成

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

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

Request Parameters

Name Type Description
card string

(任意) 新しいカードとして顧客に追加するための未使用の[トークン識別子](/ tokens-api)。

description string

(任意だが推奨) 顧客の説明。 Opn Paymentsに、顧客に関する追加の詳細情報を提供し、不正防止の検査を改善します。

email string

(任意だが推奨) 顧客のメールアドレス。 Opn Paymentsに、顧客の電子メールアドレスを提供し、不正防止の検査を改善します。

metadata object

(任意) 顧客用のカスタムメタデータ(例:{"customer-id": 42}) 。

Example

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

  • 新しい顧客の作成

顧客の削除

- DELETE https://api.omise.co/customers/{id}

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

Example

  • 顧客の削除

顧客リストの取得

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

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

Request Parameters

Name Type Description
from string

(任意, default: 1970-01-01T00:00:00Z) ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日時。

limit integer

(任意, default: 20) 返されるレコードの数。

offset integer

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

order string

(任意, default: chronological, one of: chronological, reverse_chronological) listのオーダーがchronological (古い順) or reverse_chronological (新しい順)で返されます。エントリがない場合は nullとなります。

to string

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

Example

  • 顧客リストの取得

顧客情報の取得

- GET https://api.omise.co/customers/{id}

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

Example

  • 顧客情報の取得

顧客情報の更新

- PATCH https://api.omise.co/customers/{id}

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

Request Parameters

Name Type Description
card string

(任意) 新しいカードとして顧客に追加するための未使用の[トークン識別子](/ tokens-api)。

default_card string

(任意) 課金を作成する際にデフォルトで利用されるカードのCARD_ID。デフォルトカードは顧客に割り当てられる最初のカード。削除されると、最後に追加されたカードがデフォルトカードとなる。顧客にカードが登録されていない場合、nullの値が表示される。

description string

(任意だが推奨) 顧客の説明。 Opn Paymentsに、顧客に関する追加の詳細情報を提供し、不正防止の検査を改善します。

email string

(任意だが推奨) 顧客のメールアドレス。 Opn Paymentsに、顧客の電子メールアドレスを提供し、不正防止の検査を改善します。

metadata object

(任意) 顧客用のカスタムメタデータ(例:{"customer-id": 42}) 。

Example

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

  • 顧客情報の更新

  • 顧客情報の更新

Omiseは、お客様のウェブサイト全般における利便性を向上するためにクッキーを利用し、お客様のアクセス、閲覧履歴に関する情報を収集します。 当社のウェブサイトを閲覧し続けることにより、お客様は当社のプライバシーポリシーに同意することとします。 詳細はこちら