⌨️Delete billing key API

Deletes a billing key. You must check for any scheduled payments on the billing key.

Deletes the specified billing key.

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

A deleted billing key cannot be restored.

Path Parameters

Name	Type	Description
customer_uid*	String	Billing key

Query Parameters

Name	Type	Description
reason	String	Reason for deletion
extra[requester]	String	Requester (for Naver Pay only)

401: Unauthorized Missing or invalid access token

{
    // Response
}

404: Not Found Invalid customer_uid

{
    // Response
}

200: OK Success

CustomerResponse

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)

CustomerAnnotation

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
  }
}

Swagger Test Link

https://api.iamport.kr/#!/subscribe.customer/customer_delete