Sign in
api

A simple ViewSet for viewing and editing Customers.

post/api/customers/

Request body

customer_namestring nullable

The display name of the customer

customer_idstring required

The id provided when creating the customer, we suggest matching with your internal customer id in your backend

emailstring email required

The primary email address of the customer, must be the same as the email address used to create the customer in the payment provider

payment_provider'stripe'

The payment provider this customer is associated with. Currently, only Stripe is supported.

payment_provider_idstring nullable

The customer's ID in the specified payment provider. Please note that payment_provider and payment_provider_id are mutually necessary.

propertiesobject nullable

Extra metadata for the customer

default_currency_codestring

The currency code this customer will be invoiced in. Codes are 3 letters, e.g. 'USD'.

tax_ratenumber double nullable

Tax rate as percentage. For example, 10.5 for 10.5%

Response

customer_idstring required
emailstring email required
customer_namestring required
total_amount_duenumber double required
payment_provider'stripe' | 'null' nullable required
has_payment_methodboolean required
tax_ratenumber double nullable

Tax rate as percentage. For example, 10.5 for 10.5%

Changes