Skip to content

Get organization for the authenticated account (new billing model).

GET
/account/organization
 
curl --request GET \
  --url https://api.pingram.io/account/organization \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful response

Media type application/json

Organization details for the authenticated account: identifiers, billing-cycle dates, usage caps (messages, SMS, calls, cost), and timestamps. Returned by GET /account/organization.

object
organizationId
required
string
organizationType
required
string
Allowed values: free paid
creator
required
string
name
required
string
messagesCap
required
number
costCap
required
number
smsCap
number
callCap
number
anniversaryDate
required

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

string
allowOverage
required
boolean
createdAt
required
string
updatedAt
required
string
Example 
{
  "organizationType": "free"
}

400

Section titled “400 ”

Bad Request - validation errors, invalid input

Media type application/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

Section titled “401 ”

Unauthorized

402

Section titled “402 ”

Payment Required - usage limits exceeded

Media type application/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

Section titled “500 ”

Internal Server Error

502

Section titled “502 ”

Bad Gateway - provider error

Media type application/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"
  }
}