Skip to main content
POST
/
accounts
/
{account}
Update an account
curl --request POST \
  --url https://api.chargeapi.co/v1/accounts/{account} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "email": "<string>",
  "description": "<string>",
  "metric_system": "metric",
  "plan": "<string>",
  "preferences": {
    "billing_cycle": null,
    "notifications": null,
    "default_currency": null,
    "default_payment_method": null,
    "reporting_enabled": null,
    "report_frequency": null
  },
  "metadata": {},
  "status": "active"
}'
{
  "id": null,
  "object": null,
  "business_type": null,
  "billing_details": {
    "billing_address": {
      "city": null,
      "country": null,
      "line1": null,
      "line2": null,
      "postal_code": null,
      "state": null
    }
  },
  "contact": {
    "email": null,
    "name": null,
    "phone": null
  },
  "created": null,
  "default_currency": null,
  "description": null,
  "email": null,
  "metadata": null,
  "metric_system": null,
  "name": null,
  "plan": null,
  "preferences": {
    "billing_cycle": null,
    "notifications": null,
    "default_currency": null,
    "default_payment_method": null,
    "reporting_enabled": null,
    "report_frequency": null
  },
  "registration_number": null,
  "type": null,
  "updated": null,
  "wallet_balance": null
}

Path Parameters

​
account
string
required

ID of the account to update.

Body

application/json
​
name
string

New display name for the account.

​
email
string

Updated contact email.

​
description
string

Internal description or note.

​
metric_system
enum<string>

Updated measurement system preference.

Available options:
metric,
imperial
​
plan
string

Change the subscription plan.

​
preferences
any
​
metadata
object

Merge or replace custom key-value pairs.

​
status
enum<string>

Set operational status for the account.

Available options:
active,
suspended,
archived

Response

Returns the updated Account object reflecting the supplied changes.

​
id
string

Unique identifier for the account object.

Example:

null

​
object
string

String representing the object’s type. Always account.

Example:

null

​
business_type
string | null

Type of legal entity associated with the account (e.g., individual, business).

Example:

null

​
billing_details
object

Billing information used for invoicing and reports.

​
contact
object

Primary contact person for the account.

​
created
integer

Time at which the account was created (UNIX timestamp).

Example:

null

​
default_currency
string

Three-letter ISO currency code for default billing and pricing (e.g., usd).

Example:

null

​
description
string | null

Optional internal description or label for the account.

Example:

null

​
email
string | null

Email address associated with the account (may duplicate contact.email).

Example:

null

​
metadata
object

Set of key-value pairs to store custom structured data.

Example:

null

​
metric_system
string | null

Preferred measurement system. Either metric or imperial.

Example:

null

​
name
string | null

Display name or registered name of the account.

Example:

null

​
plan
string

Subscription or feature plan assigned to the fleet (e.g., professional).

Example:

null

​
preferences
object

Account-level preferences for billing, notifications, and reports.

​
registration_number
string | null

Government-issued registration number (for businesses).

Example:

null

​
type
string

Type of account, such as individual or business.

Example:

null

​
updated
integer

Time at which the account was last updated (UNIX timestamp).

Example:

null

​
wallet_balance
integer

Current account wallet balance in the smallest currency unit (e.g., cents).

Example:

null