| Field | Type | Required | Description | Example |
|---|---|---|---|---|
name |
JsonNullable<String> | ➖ | The full name of the customer. | John Doe |
email |
JsonNullable<String> | ➖ | The email address of the customer. If the domain contains non-ASCII characters, encode it as Punycode per RFC 3492. |
example@email.com |
locale |
JsonNullable<LocaleResponse> | ➖ | Allows you to preset the language to be used. | en_US |
metadata |
JsonNullable<Metadata> | ➖ | Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB. |
|
testmode |
Optional<Boolean> | ➖ | Whether the entity was created in test mode or live mode. This field does not update the mode of the entity. Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting testmode to true. |
false |