Sub-Organizations

Get a sub-organization.

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

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

Changed in 1 of the 7 revisions of this API.44

    • added the new internal_server_error enum value to the error/type response property for the response status 500

      response-property-enum-value-added

    • added the new invalid_sub_organization_id_error enum value to the error/type response property for the response status 400

      response-property-enum-value-added

    • added the new rate_limit_exceeded_error enum value to the error/type response property for the response status 429

      response-property-enum-value-added

    • added the new sub_organizations_not_enabled_error enum value to the error/type response property for the response status 403

      response-property-enum-value-added

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

      response-body-any-of-added

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

      response-body-any-of-added

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

      response-body-any-of-removed

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

      response-body-any-of-removed

    This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog