Skip to main content
POST
billing.customer.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
customerId
string
required

Customer id in your billing account.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
name
string

Customer name.

Required string length: 1 - 200
email
string

Customer email address.

Required string length: 1 - 320
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
locale
string

Language and country code, such as en_GB.

Required string length: 1 - 5
Pattern: ^[a-z]{2}_[A-Z]{2}$
metadata
object

Optional business labels stored in your payment account; do not include secrets.

Response

The result

customerId
string
required

The customer's id. Pass it to other billing capabilities.

email
string

Email address, lowercase.

name
string

Customer name.

createdAt
string

When the customer was created, ISO 8601.

locale
string

Customer language and country code, when set.