⌨ī¸Get scheduled payments API

Gets scheduled payments by billing key.

Gets scheduled payments by billing key.

GET https://api.iamport.kr/subscribe/customers/{customer_uid}/schedules

Returns scheduled payments using pagination (up to 3 months period).

Path Parameters

NameTypeDescription

customer_uid*

String

Billing key

Query Parameters

NameTypeDescription

page

integer

Search result paging

Starts at 1 (default: 1)

from*

integer

Search start time

UNIX timestamp

to*

integer

Search end time

UNIX timestamp

schedule-status

String

Schedule status

If not specified, returns for all status

scheduled

executed

revoked

{
    // Response
}
Response Model Schema
{
  "code": 0,
  "message": "string",
  "response": [
    {
      "customer_uid": "string",
      "merchant_uid": "string",
      "imp_uid": "string",
      "schedule_at": "0",
      "executed_at": "0",
      "revoked_at": "0",
      "amount": 0,
      "name": "string",
      "buyer_name": "string",
      "buyer_email": "string",
      "buyer_tel": "string",
      "buyer_addr": "string",
      "buyer_postcode": "string",
      "custom_data": "string",
      "schedule_status": "scheduled",
      "payment_status": "paid",
      "fail_reason": "string"
    }
  ]
}

Last updated