Sign in

v1

latestOpenAPI 3.0.12026-07-141671231.8 MB
Customers

Retrieve an individual customer

This endpoint returns an individual customer.

ℹ️ This endpoint requires one of the following scopes: customers:all, customers:readonly

get/api/external/v2/individual_customers/{id}

Path parameters

idstring required

Individual customer identifier

Response

Returns an individual customer

idinteger required
namestring required
billing_ibanstring nullable required
payment_conditions'upon_receipt' | 'custom' | '7_days' | '15_days' | '30_days' | '30_days_end_of_month' | '45_days' | '45_days_end_of_month' | '60_days' required

Note that the custom option is only used on Pennylane's web app to avoid pre-filling the deadline when creating an invoice. On the API it has no effect and you will still have to provide a deadline when creating an invoice.

recipientstring required
phonestring required
referencestring nullable required
notesstring nullable required
first_namestring required
last_namestring required
emailsstring[] required
created_atstring date-time required
updated_atstring date-time required
external_referencestring required

The unique external reference assigned to this customer, assigned on creation either by you or Pennylane. (Same attribute as source_id in the API v1)

billing_language'fr_FR' | 'en_GB' | 'de_DE' required

The language in which the customer will receive invoices. Default is fr_FR

Example response

{
  "id": 42,
  "name": "John Doe",
  "billing_iban": "FR1420041010050500013M02606",
  "recipient": "John Doe",
  "phone": "+33612345678",
  "reference": "REF-1234",
  "notes": "Some notes",
  "first_name": "John",
  "last_name": "Doe",
  "emails": [
    "hello@example.org"
  ],
  "created_at": "2023-08-30T10:08:08.146343Z",
  "updated_at": "2023-08-30T10:08:08.146343Z",
  "external_reference": "0e67fc3c-c632-4feb-ad34-e18ed5fbf66a",
  "mandates": {
    "url": "https://app.pennylane.com/api/external/v2/gocardless_mandates?filter=%5B%7B%5C\"field%5C\":%5C\"customer_id%5C\",%5C\"operator%5C\":%5C\"eq%5C\",%5C\"value%5C\":%5C\"42%5C\"%7D%5D"
  },
  "pro_account_mandates": {
    "url": "https://app.pennylane.com/api/external/v2/pro_account/mandates?filter=%5B%7B%22field%22%3A%22customer_id%22%2C%22operator%22%3A%22eq%22%2C%22value%22%3A%2242%22%7D%5D"
  },
  "contacts": {
    "url": "https://app.pennylane.com/api/external/v2/customers/42/contacts"
  }
}