Sub-Organizations

Get a sub-organization.

Changed on
get/print-mail/v1/sub_organizations/{id}

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/print-mail/v1/sub_organizations/{id}
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

Response

The request has succeeded.

idstring required

A unique ID prefixed with sub_org_.

object'sub_org' required

Always sub_org.

namestring required

The name of the sub-organization.

countryCodestring required

The country code of the sub-organization.

limitinteger required

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

spendinteger required

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

usageinteger required

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

createdAtstring date-time required

The UTC time at which this resource was created.

updatedAtstring date-time required

The UTC time at which this resource was last update.

Changes

  • c8fedcbd705eRevision changes
    • warning

      added the new internal_server_error enum value to the / response property for the response status

    • warning

      added the new invalid_sub_organization_id_error enum value to the / response property for the response status

    • warning

      added the new rate_limit_exceeded_error enum value to the / response property for the response status

    • warning

      added the new sub_organizations_not_enabled_error enum value to the / response property for the response status

    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body anyOf list for the response status