v1

latestOpenAPI 3.0.22026-07-2667277423.4 KB

Subscriptions

Customer: Create

Creates a new customer with the specified payment_details. Customer payment details are stored in a secure, PCI DSS-compliant way.

Once you have a customer, you may specify the customer's id instead of payment_details when creating a payment.

post/customers

Request body

currency'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND'

3-letter ISO currency code.

emailstring

Customer's email address.

metadataobject

Store any additional data you want to associate with the customer. The object's keys and values must be strings. Keys have a maximum length of 30 characters. Values have a maximum length of 2000 characters.

Example request

{
  "currency": "JPY",
  "payment_details": {
    "email": "example@komoju.com",
    "number": "4111111111111111",
    "month": 10,
    "year": 2031,
    "verification_value": "000",
    "name": "John Doe",
    "given_name": "John",
    "family_name": "Doe",
    "expiry_days": 2,
    "scheme_reference": "SUBSCRIPTION-1234",
    "installments": "3",
    "shipping_address_name": "Taro Tanaka",
    "shipping_address_line1": "5-2-1 Ginza",
    "shipping_address_line2": "3rd floor",
    "shipping_address_city": "Chuo-ku",
    "shipping_address_state": "Tokyo",
    "shipping_address_zip": "170-3293",
    "shipping_address_country": "Japan",
    "billing_address_name": "Taro Tanaka",
    "billing_address_line1": "5-2-1 Ginza",
    "billing_address_line2": "3rd floor",
    "billing_address_city": "Chuo-ku",
    "billing_address_state": "Tokyo",
    "billing_address_zip": "170-3293",
    "billing_address_country": "Japan"
  }
}

Response

200 response

idstring required

A unique 25-character alphanumeric resource identifier.

resource'customer' required

Resource type name, always "customer".

emailstring nullable required

Customer's email address, or null if not provided.

metadataobject required

Arbitrary key-value metadata attached to this customer.

created_atstring date-time required

Timestamp when the customer was created.

locale'ja' | 'en' | 'ko'

For supported payment methods, sets the language of the instruction page.