Charge Schedule（定期課金） API

定期課金（Charge schedule）は、Schedule機能の１つで、定期的に課金するために利用できます。スケジュールの詳細については、 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	`card`が`customer`のデフォルトカードかどうか。
description	string	課金スケジュールの説明。
metadata	object	Custom metadata (e.g. `{"answer": 42}`) for charge schedule.

Example

JSON Response

{
  "object": "scheduled_charge",
  "id": "rchg_test_no1t4tnemucod0e51mo",
  "livemode": false,
  "currency": "THB",
  "amount": 12345,
  "default_card": true,
  "card": "card_test_no1t4tnemucod0e51mo",
  "customer": "cust_test_no1t4tnemucod0e51mo",
  "description": "Subscription for coffee beans",
  "metadata": {
    "answer": 42
  },
  "created_at": "2019-12-31T12:59:59Z"
}

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

- 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

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

curl
php
node.js
ruby
C#
java
python
go
elixir

curl https://api.omise.co/charges/schedules \
  -u $OMISE_SECRET_KEY:

<?php

require './omise-php/lib/Omise.php';

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$schedules = OmiseCharge::schedules();

const omise = require('omise')({
  secretKey: 'skey_test_no1t4tnemucod0e51mo',
});

const schedule = await omise.charges.schedules();
console.log(schedule);

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

schedules = Omise::Charge.schedules

var schedules = await Client
    .Charges
    .Schedules
    .GetList(order: Ordering.ReverseChronological);

Console.WriteLine($"total charge schedules: {schedules.Total}");

Request<ScopedList<Schedule>> request = new Schedule.ChargeScheduleListRequestBuilder().build();
ScopedList<Schedule> schedules = client().sendRequest(request);

System.out.printf("Total no. of charge schedules: %d", schedules.getTotal());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

schedule = omise.Charge.schedule()

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.ScheduleList{}
err := client.Do(result, &operations.ListChargeSchedules{
	List: operations.List{
		Limit: 100,
		From:  time.Now().Add(-1 * time.Hour),
	},
})

if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Charge.list_schedules