Update account billing preferences such as auto upgrade and usage email alerts.

PATCH

/account

curl --request PATCH \
  --url https://api.pingram.io/account \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "autoUpgrade": true, "billingAlerts": { "enabled": true, "emails": [ "example" ], "thresholds": [ 1 ] } }'

• Production

Authorizations

• apiKey
• clientCredentials
• endUser
• endUserHashed

Request Body^required

Media typeapplication/json

PATCH /account request: billing preferences.

object

autoUpgrade

When true, automatically move up one budget tier at 90% of the monthly budget.

boolean

billingAlerts

Email alerts for monthly usage. New accounts start enabled for the creator at 80% and 100%.

object

enabled

required

When false, saved addresses and thresholds are kept but no email is sent.

boolean

emails

required

Addresses that receive threshold emails. At most three.

Array<string>

thresholds

required

Percents to email, from 5 to 100 in steps of 5. At most two. At least one is required while enabled.

Array<number>

Example^generated

{
  "autoUpgrade": true,
  "billingAlerts": {
    "enabled": true,
    "emails": [
      "example"
    ],
    "thresholds": [
      1
    ]
  }
}

Responses

200

Successful response

Media typeapplication/json

GET /account response: public plan fields for the authenticated account.

object

accountId

required

string

accountType

required

string

Allowed values: free paid

creator

string

name

string

messagesCap

required

number

costCap

required

number

smsCap

number

callCap

number

billingVersion

When omitted, defaults to LATEST_BILLING_VERSION.

number

Allowed values: 1 3

anniversaryDate

required

ISO date (YYYY-MM-DD) when the billing cycle resets.

string

createdAt

required

string

updatedAt

required

string

status

string

Allowed values: verified unverified blocked

subscriptionStatus

string

nullable

Allowed values: active canceled past_due paused

pendingDowngradeEffectiveDate

string

pendingDowngradeCostCap

number

pendingDowngradeAccountType

string

Allowed values: free

autoUpgrade

When true, paid accounts move up one budget tier at 90% of the monthly budget.

boolean

billingAlerts

Email alerts for monthly usage. New accounts start enabled for the creator at 80% and 100%.

object

enabled

required

When false, saved addresses and thresholds are kept but no email is sent.

boolean

emails

required

Addresses that receive threshold emails. At most three.

Array<string>

thresholds

required

Percents to email, from 5 to 100 in steps of 5. At most two. At least one is required while enabled.

Array<number>

Example

{
  "accountType": "free",
  "billingVersion": 1,
  "status": "verified",
  "subscriptionStatus": "active",
  "pendingDowngradeAccountType": "free"
}

400

Bad Request - validation errors, invalid input

Media typeapplication/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

401

Unauthorized

402

Payment Required - usage limits exceeded

Media typeapplication/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

500

Internal Server Error

502

Bad Gateway - provider error

Media typeapplication/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}