Charge Schedule

การทำงานของ Charge Schedule API คือช่วยสร้าง, เรียกข้อมูล หรือลบรายการรับชำระเงินที่ได้มีการตั้งล่วงหน้าเอาไว้ด้วย schedule เมื่อต้องการตั้งรายการรับชำระเงินล่วงหน้าใหม่ ให้สร้าง schedule และเพิ่ม object นี้ใน field charge. สำหรับการใช้งาน Schedule API นั้น จะไม่สามารถใช้งานได้กับบัญชีที่เปิดใช้งาน 3-D Secure ณ ขณะนี้

Attributes

Name Type Description
object string

The string scheduled_charge.

id string

The scheduled charge identifier matching /rchg(_test)?_[0-9a-z]+/.

livemode boolean

Whether this is a live (true) or test (false) scheduled charge.

amount integer

Scheduled charge amount in smallest unit of charge currency.

card object_id_expandable

Identifier for card to be charged. If a card was not specified at charge schedule creation, this is the customer's current default card.

created_at string

UTC datetime of scheduled charge creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

currency string

Currency for scheduled charge as three-letter ISO 4217 code.

customer object_id_expandable

Identifier for customer to be charged.

default_card boolean

Whether card is default card of customer.

description string

Scheduled charge description.

metadata object

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

Example

  • JSON Response

List charge schedules

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

Returns a list of charge schedules belonging to your account.

Request Parameters

Name Type Description
from string

(optional, default: 1970-01-01T00:00:00Z) Earliest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

limit integer

(optional, default: 20) Number of records returned.

offset integer

(optional, default: 0) Offset of the first record returned (i.e. how many records to skip from the beginning).

order string

(optional, default: chronological, one of: chronological, reverse_chronological) Order of records returned.

to string

(optional) Latest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

Example

  • List all charge schedules

เว็ปไซต์นี้มีการใช้คุกกี้เพื่อวิเคราะห์การใช้และปรับการใช้งานให้เหมาะกับท่าน เมื่อกดยอมรับหรือยังคงเข้าชมเว็บไซต์ต่อ เราถือว่าท่านยินยอมในการใช้งานคุกกี้ของเว็บไซต์ อ่านนโยบายความเป็นส่วนตัว