Charge Schedule(定期課金) API

定期課金(Charge schedule)は、Schedule機能の1つで、定期的に課金するために利用できます。 スケジュールの詳細については、 Schedule(スケジュール)API をご覧ください。

注:このAPIの使用は[3DS対応](https://www.omise.co/how-to-implement-3-D-Secure)のアカウントに対して無効になっています。

Attributes

Name Type Description
object string

固定値scheduled_charge

id string

/rchg(_test)?_[0-9a-z]+/に一致する定期課金ID。

livemode boolean

本番モード (true) あるいはテストモード(false) の定期課金。

amount integer

smallest currency unit(最小通貨単位)での課金スケジュールの金額。

card object_id_expandable

課金される CARD_ID

created_at string

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

currency string

3文字の課金スケジュール通貨ISO 4217コード。

customer object_id_expandable

課金されるCUSTOMER_ID

default_card boolean

cardcustomerのデフォルトカードかどうか。

description string

課金スケジュールの説明。

metadata object

Custom metadata (e.g. {"answer": 42}) for charge schedule.

Example

  • JSON Response

全ての定期課金リストを取得

- GET https://api.omise.co/charges/schedules

charge_scheduleに属するすべての お客様のアカウントオブジェクトの 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

  • 全ての定期課金リストを取得

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