Subscription Event

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/usps/json-schema/usps-unpaid-packages-notification-schema.json",
  "title": "Subscription Event",
  "description": "Subscription Event",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/usps-subscriptions-unpaid-packages-openapi.yml#/components/schemas/UnpaidPackagesNotification",
  "additionalProperties": false,
  "allOf": [
    {
      "$ref": "#/$defs/Notification"
    },
    {
      "type": "object",
      "properties": {
        "payload": {
          "oneOf": [
            {
              "$ref": "#/$defs/UnpaidPackagesDetails"
            }
          ]
        }
      }
    }
  ],
  "$defs": {
    "Links": {
      "title": "Hypermedia Links",
      "type": "array",
      "description": "Hypermedia links to related resources.",
      "items": {
        "required": [
          "href",
          "rel"
        ],
        "type": "object",
        "properties": {
          "rel": {
            "type": "array",
            "description": "The short name(s) of the relationship corresponding to the link.",
            "items": {
              "type": "string"
            }
          },
          "title": {
            "type": "string",
            "description": "A human-readable description of the link relationship."
          },
          "href": {
            "type": "string",
            "description": "The URL to a related resource.",
            "format": "uri"
          },
          "method": {
            "type": "string",
            "description": "The HTTP method to use to access this link.",
            "enum": [
              "GET",
              "POST",
              "PUT",
              "DELETE"
            ]
          },
          "submissionMediaType": {
            "type": "string",
            "description": "The media type of the resource request."
          },
          "targetMediaType": {
            "type": "string",
            "description": "The media type of the resource response."
          }
        },
        "additionalProperties": false
      }
    },
    "Notification": {
      "title": "Subscription Event",
      "type": "object",
      "properties": {
        "subscriptionId": {
          "type": "string",
          "description": "Unique identifier created for this Subscription"
        },
        "subscriptionType": {
          "type": "string",
          "description": "The name of the topic related to this event."
        },
        "timestamp": {
          "type": "string",
          "description": "Timestamp message was generated, in ISO-8601 format.",
          "format": "date-time"
        },
        "links": {
          "$ref": "#/$defs/Links"
        }
      },
      "additionalProperties": true,
      "description": "Subscription Event"
    },
    "UnpaidPackagesDetails": {
      "type": "object",
      "properties": {
        "PIC": {
          "type": "string",
          "description": "Package Identification Code, parsed from the IMpb."
        },
        "CRID": {
          "type": "string",
          "description": "The Customer Registration ID associated with the subscription."
        },
        "MID": {
          "pattern": "^(\\d{6}|\\d{9})$",
          "type": "string",
          "description": "Mailer Identifier. A field within a field within the Intelligent Mail barcode that is used to identify mailers. MIDs are assigned by the USPS to a Mail Owner, Mailing Agent or other service providers who request them."
        },
        "serviceTypeCode": {
          "type": "string",
          "description": "The service Type Code of the mail piece.  Refer to the lookup table for all the possible values.  USPS Pub 199 Appendix I: Intelligent Mail Package Barcode Service Type Codes"
        },
        "scanDateTime": {
          "type": "string",
          "description": "The date and time which the barcode of a package was scanned and no matching payment documentation was found.",
          "format": "date-time"
        }
      },
      "additionalProperties": false,
      "description": "Details on unpaid packages that will be or have been issued to a customer account. Fields will only be provided if they differed from the original manifested data."
    }
  }
}