API Reference

Print Mail

Sub Organizations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get a sub-organization.

GET/print-mail/v1/sub_organizations/{id}

Get a sub-organization.

Path ParametersExpand Collapse

id: string

ReturnsExpand Collapse

SubOrganization = object { id, countryCode, createdAt, 6 more }

The Sub-Organization object.

id: string

A unique ID prefixed with sub_org_.

countryCode: string

The country code of the sub-organization.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

limit: number

The limit of mailings the sub-organization can send before being charged overages for the month.

name: string

The name of the sub-organization.

object: "sub_org"

Always sub_org.

spend: number

The current rolling charge for the sub-organization for the month, in cents.

updatedAt: string

The UTC time at which this resource was last update.

formatdate-time

usage: number

The amount of mail the sub-organization has sent out this month.

Get a sub-organization.

HTTP

HTTP

TypeScript

Python

curl https://api.postgrid.com/print-mail/v1/sub_organizations/$ID \
    -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY"

200 example

{
  "usage": 0,
  "limit": 500,
  "spend": 0,
  "name": "PostGrid",
  "countryCode": "CA",
  "id": "sub_org_abc123def456ghi6789",
  "object": "sub_org",
  "createdAt": "2020-11-12T23:23:47.974Z",
  "updatedAt": "2020-11-12T23:23:47.974Z"
}

Returns Examples

200 example

{
  "usage": 0,
  "limit": 500,
  "spend": 0,
  "name": "PostGrid",
  "countryCode": "CA",
  "id": "sub_org_abc123def456ghi6789",
  "object": "sub_org",
  "createdAt": "2020-11-12T23:23:47.974Z",
  "updatedAt": "2020-11-12T23:23:47.974Z"
}