Arcadia · Schema

BundleEnrollment

EnergyUtilitiesClean EnergyBilling DataInterval DataCarbonSolarTariff

Properties

Name	Type	Description
client_user_id	string	Your organization's unique key provided to associate Arcadia resources with your user.
utility_account_id	integer	Unique `id` generated by Arcadia to identify the Utility Account associated with this resource.
product_key	string
status	object
ineligibility_reasons	array	Reasons, if any, that an Account was ineligible for Bundle. This array will always be present but may be empty.
removal_reason	object
start_date	string	Date the Bundle Enrollment was approved.
override_email	string	Email address generated by Arcadia to override the user's email address on file with their Utility.
sandboxed	boolean	If `true`, this resource is in the sandboxed environment. If `false`, this resource is in the live environment.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.arcadia.com/schemas/BundleEnrollment",
  "title": "BundleEnrollment",
  "required": [
    "client_user_id",
    "utility_account_id",
    "product_key",
    "status",
    "ineligibility_reasons",
    "removal_reason",
    "start_date",
    "override_email",
    "sandboxed"
  ],
  "properties": {
    "client_user_id": {
      "description": "Your organization's unique key provided to associate Arcadia resources with your user.",
      "type": "string",
      "example": "fff57dc7-3a2b-4395-8a62-e3486d46dabe"
    },
    "utility_account_id": {
      "description": "Unique `id` generated by Arcadia to identify the Utility Account associated with this resource.",
      "type": "integer",
      "example": 1234
    },
    "product_key": {
      "type": "string",
      "enum": [
        "hosted_payments",
        "utility_remittance"
      ]
    },
    "status": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "string",
          "enum": [
            "enrolled",
            "pending_enrollment",
            "ineligible",
            "pending_removal",
            "removed"
          ]
        }
      ],
      "example": "enrolled"
    },
    "ineligibility_reasons": {
      "description": "Reasons, if any, that an Account was ineligible for Bundle. This array will always be present but may be empty.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IneligibilityReason"
      }
    },
    "removal_reason": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "string",
          "enum": [
            "organization_requested",
            "dropped_cant_login",
            "dropped_payment_decline",
            "dropped_no_remittance_scheduled",
            "moved"
          ]
        }
      ],
      "example": null
    },
    "start_date": {
      "description": "Date the Bundle Enrollment was approved.",
      "format": "date",
      "type": "string",
      "nullable": true
    },
    "override_email": {
      "description": "Email address generated by Arcadia to override the user's email address on file with their Utility.",
      "example": "[email protected]",
      "type": "string",
      "nullable": true
    },
    "sandboxed": {
      "description": "If `true`, this resource is in the sandboxed environment. If `false`, this resource is in the live environment.",
      "type": "boolean",
      "example": false
    }
  },
  "additionalProperties": false
}