Create a customer

You can create customer's basic profile in Speed, which can then be useful while billing them by creating Invoices / Subscriptions later.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

In this parameter, you must specify your customer's name.

string
required

In this parameter, you must specify your customer's email address.

string

In this parameter, you can specify your customer's preferred base currency (fiat or SATS/BTC). A three-lettered ISO-compliant currency name must be used.

billing
object

In this parameter, you must specify your customer's billing details.

shipping
object

In this parameter, you must specify your customer's shipping details.

string

In this parameter, you must specify your customer's description.

string

In this parameter, you must specify your customer's phone number.

string

In this parameter, you must specify your customer's calling_code.

json
Defaults to { "key_1": "value_1", "key_2": "value_2" }

You can use this to store additional information about the object in a structured format. In this parameter, you can add up to 50 key-value pairs in a raw JSON format.

Headers
string
enum
Defaults to 2022-04-15

In this parameter, you can specify the version you want. As of now, there are two versions (2022-04-15 and 2022-10-15). Version 2022-10-15 supports both on-chain and lightning payment methods. Whereas the 2022-04-15 version only supports lightning payments.

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Questions? Contact us