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.

print_mail.sub_organizations.retrieve(strid) -> SubOrganization

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

Get a sub-organization.

ParametersExpand Collapse

id: str

ReturnsExpand Collapse

class SubOrganization: …

The Sub-Organization object.

id: str

A unique ID prefixed with sub_org_.

country_code: str

The country code of the sub-organization.

created_at: datetime

The UTC time at which this resource was created.

formatdate-time

limit: int

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

name: str

The name of the sub-organization.

object: Literal["sub_org"]

Always sub_org.

spend: int

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

updated_at: datetime

The UTC time at which this resource was last update.

formatdate-time

usage: int

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

Get a sub-organization.

Python

HTTP

TypeScript

Python

import os
from postgrid import PostGrid

client = PostGrid(
    print_mail_api_key=os.environ.get("POSTGRID_PRINT_MAIL_API_KEY"),  # This is the default and can be omitted
)
sub_organization = client.print_mail.sub_organizations.retrieve(
    "id",
)
print(sub_organization.id)

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"
}