GOgocardless
Customer

Create a customer

Creates a new customer object.

<p class="restricted-notice"><strong>Restricted</strong>: this endpoint is [restricted](https://docs.gocardless.com/docs/api-reference/restrictions) to [GoCardless Pro](https://gocardless.com/pricing) and [GoCardless Enterprise](https://gocardless.com/pricing) accounts with approved payment pages.</p> <p class="notice--warning"><strong>Warning</strong>: this endpoint is a legacy API endpoint and does not support GoCardless' newest features. We recommend using the [Billing Requests API](https://docs.gocardless.com/docs/collect-payments/setting-up-mandates) instead.</p>
post/customers

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "customers": {
    "email": "user@example.com",
    "given_name": "Frank",
    "family_name": "Osborne",
    "company_name": "Hamilton Trading Ltd.",
    "address_line1": "221B Baker Street",
    "address_line2": "Marylebone",
    "address_line3": "City of Westminster",
    "city": "London",
    "region": "Greater London",
    "postal_code": "NW1 6XE",
    "country_code": "GB",
    "language": "en",
    "phone_number": "+64 4 817 9999",
    "swedish_identity_number": "556564-5404",
    "danish_identity_number": "2205506218"
  }
}

Response

Resource created successfully

Example response

{
  "customers": {
    "id": "CU123",
    "created_at": "2014-01-01T12:00:00.000Z",
    "email": "user@example.com",
    "given_name": "Frank",
    "family_name": "Osborne",
    "company_name": "Hamilton Trading Ltd.",
    "address_line1": "221B Baker Street",
    "address_line2": "Marylebone",
    "address_line3": "City of Westminster",
    "city": "London",
    "region": "Greater London",
    "postal_code": "NW1 6XE",
    "country_code": "GB",
    "language": "en",
    "phone_number": "+64 4 817 9999",
    "swedish_identity_number": "556564-5404",
    "danish_identity_number": "2205506218"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.