⌨ī¸Get billing keys API

Gets details of multiple billing keys.

Get details of multiple billing keys.

GET https://api.iamport.kr/subscribe/customers

Gets details (card info) of billing keys for the specified array of customer_uids. Each card is mapped to a unique customer_uid.

Query Parameters

NameTypeDescription

customer_uid[]*

Array

Billing key

code * integer

Response code

0: success, Not 0: check the message

message * string

Response message

A non-zero code includes a message like 'Invalid payment info'.

response (CustomerAnnotation, optional)

code * integer

Response code

0: success, Not 0: check the message

message * string

Response message

A non-zero code includes a message like 'Invalid payment info'.

customer_uid * string

Customer ID

pg_provider * string

PG code for billing key

pg_id * string

PG merchant ID (MID) for billing key

card_name * string

Credit card name

card_code * string

Credit card code

card_number * string

Masked card number

card_type * string

Credit card type

Not supported in some PGs (returns null)

customer_name * string

Customer name

customer_tel * string

Customer phone

customer_email * string

Customer email

customer_addr * string

Customer address

customer_postcode * string

Customer zip code

inserted * integer

Billing key issued at (UNIX timestamp)

updated * integer

Billing key updated at (UNIX timestamp)

Response Model Schema
{
  "code": 0,
  "message": "string",
  "response": [
    {
      "customer_uid": "string",
      "pg_provider": "string",
      "pg_id": "string",
      "card_name": "string",
      "card_code": "string",
      "card_number": "string",
      "card_type": "null",
      "customer_name": "string",
      "customer_tel": "string",
      "customer_email": "string",
      "customer_addr": "string",
      "customer_postcode": "string",
      "inserted": 0,
      "updated": 0
    }
  ]
}

Last updated