Currently there are several Plans setup in Recurly that are used for CCH Subscriptions. Below are those plans, their plan code, and the newly added State Agency Content Pack Add-Ons that go with each subscription:
CCH Basic Subscription, monthly - ucf-12000001
Name | Add-on Code | Accounting Code | Restriction | Implemented in Production |
|---|---|---|---|---|
Additional User, monthly | ucf-12000002 | ucf-12000002 | Yes | |
Compliance Templates, monthly | ucf-12000003 | ucf-12000003 | Yes | |
Custom Glossary, monthly | ucf-12000004 | ucf-12000004 | Yes | |
API Access, monthly | ucf-12000005 | ucf-12000005 | Yes | |
OEM API, monthly | ucf-12000006 | ucf-12000006 | Yes | |
UCF Mapper, monthly | ucf-12000009 | ucf-12000009 | Yes | |
Energy NERC+, monthly | ucf-12000011 | ucf-12000011 | energy | No |
Alabama State Agencies, monthly | ucf-12000012 | ucf-12000012 | stateAgencyAlabama | No |
California State Agencies, monthly | ucf-12000013 | ucf-12000013 | stateAgencyCalifornia | No |
Texas State Agencies, monthly | ucf-12000014 | ucf-12000014 | stateAgencyTexas | No |
New York State Agencies, monthly | ucf-12000015 | ucf-12000015 | stateAgencyNewYork | No |
Colorado State Agencies, monthly | ucf-12000016 | ucf-12000016 | stateAgencyColorado | No |
Arizona State Agencies, monthly | ucf-12000017 | ucf-12000017 | stateAgencyArizona | No |
CCH Basic Subscription, yearly - ucf-00000001
Name | Add-on Code | Accounting Code | Restriction | Implemented in Production |
|---|---|---|---|---|
Additional User, yearly | ucf-00000002 | ucf-00000002 | Yes | |
Compliance Templates, yearly | ucf-00000003 | ucf-00000003 | Yes | |
Custom Glossary, yearly | ucf-00000004 | ucf-00000004 | Yes | |
API Access, yearly | ucf-00000005 | ucf-00000005 | Yes | |
OEM API, yearly | ucf-00000006 | ucf-00000006 | Yes | |
UCF Mapper, yearly | ucf-00000009 | ucf-00000009 | Yes | |
Energy NERC+, yearly | ucf-00000011 | ucf-00000011 | energy | No |
Alabama State Agencies, yearly | ucf-00000012 | ucf-00000012 | stateAgencyAlabama | No |
California State Agencies, yearly | ucf-00000013 | ucf-00000013 | stateAgencyCalifornia | No |
Texas State Agencies, yearly | ucf-00000014 | ucf-00000014 | stateAgencyTexas | No |
New York State Agencies, yearly | ucf-00000015 | ucf-00000015 | stateAgencyNewYork | No |
Colorado State Agencies, yearly | ucf-00000016 | ucf-00000016 | stateAgencyColorado | No |
Arizona State Agencies, yearly | ucf-00000017 | ucf-00000017 | stateAgencyArizona | No |
CCH Basic Subscription, 24 months, billed every 24 months - ucf-p-1-24-24
Name | Add-on Code | Accounting Code | Restriction | Implemented in Production |
|---|---|---|---|---|
Additional User, 24 months, billed every 24 months | ucf-a-2-24-24 | ucf-a-2-24-24 | Yes | |
Compliance Templates, 24 months, billed every 24 months | ucf-a-3-24-24 | ucf-a-3-24-24 | Yes | |
Custom Glossary, 24 months, billed every 24 months | ucf-a-4-24-24 | ucf-a-4-24-24 | Yes | |
API Access, 24 months, billed every 24 months | ucf-a-5-24-24 | ucf-a-5-24-24 | Yes | |
OEM API, 24 months, billed every 24 months | ucf-a-6-24-24 | ucf-a-6-24-24 | Yes | |
UCF Mapper, 24 months, billed every 24 months | ucf-a-9-24-24 | ucf-a-9-24-24 | Yes | |
Energy NERC+, 24 months, billed every 24 months | ucf-a-11-24-24 | ucf-a-11-24-24 | energy | No |
Alabama State Agencies, 24 months, billed every 24 months | ucf-a-12-24-24 | ucf-a-12-24-24 | stateAgencyAlabama | No |
California State Agencies, 24 months, billed every 24 months | ucf-a-13-24-24 | ucf-a-13-24-24 | stateAgencyCalifornia | No |
Texas State Agencies, 24 months, billed every 24 months | ucf-a-14-24-24 | ucf-a-14-24-24 | stateAgencyTexas | No |
New York State Agencies, 24 months, billed every 24 months | ucf-a-15-24-24 | ucf-a-15-24-24 | stateAgencyNewYork | No |
Colorado State Agencies, 24 months, billed every 24 months | ucf-a-16-24-24 | ucf-a-16-24-24 | stateAgencyColorado | No |
Arizona State Agencies, 24 months, billed every 24 months | ucf-a-17-24-24 | ucf-a-17-24-24 | stateAgencyArizona | No |
CCH Basic Subscription, 36 months, billed every 36 months - ucf-p-1-36-36
Name | Add-on Code | Accounting Code | Restriction | Implemented in Production |
|---|---|---|---|---|
Additional User, 36 months, billed every 36 months | ucf-a-2-36-36 | ucf-a-2-36-36 | Yes | |
Compliance Templates, 36 months, billed every 36 months | ucf-a-3-36-36 | ucf-a-3-36-36 | Yes | |
Custom Glossary, 36 months, billed every 36 months | ucf-a-4-36-36 | ucf-a-4-36-36 | Yes | |
API Access, 36 months, billed every 36 months | ucf-a-5-36-36 | ucf-a-5-36-36 | Yes | |
OEM API, 36 months, billed every 36 months | ucf-a-6-36-36 | ucf-a-6-36-36 | Yes | |
UCF Mapper, 36 months, billed every 36 months | ucf-a-9-36-36 | ucf-a-9-36-36 | Yes | |
Energy NERC+, 36 months, billed every 36 months | ucf-a-11-36-36 | ucf-a-11-36-36 | energy | Yes |
Alabama State Agencies, 36 months, billed every 36 months | ucf-a-12-36-36 | ucf-a-12-36-36 | stateAgencyAlabama | Yes |
California State Agencies, 36 months, billed every 36 months | ucf-a-13-36-36 | ucf-a-13-36-36 | stateAgencyCalifornia | No |
Texas State Agencies, 36 months, billed every 36 months | ucf-a-14-36-36 | ucf-a-14-36-36 | stateAgencyTexas | No |
New York State Agencies, 36 months, billed every 36 months | ucf-a-15-36-36 | ucf-a-15-36-36 | stateAgencyNewYork | No |
Colorado State Agencies, 36 months, billed every 36 months | ucf-a-16-36-36 | ucf-a-16-36-36 | stateAgencyColorado | No |
Arizona State Agencies, 36 months, billed every 36 months | ucf-a-17-36-36 | ucf-a-17-36-36 | stateAgencyArizona | No |
CCH Basic Subscription, 48 months, billed every 48 months - ucf-p-1-48-48
Name | Add-on Code | Accounting Code | Restriction | Implemented in Production |
|---|---|---|---|---|
Additional User, 48 months, billed every 48 months | ucf-a-2-48-48 | ucf-a-2-48-48 | Yes | |
Compliance Templates, 48 months, billed every 48 months | ucf-a-3-48-48 | ucf-a-3-48-48 | Yes | |
Custom Glossary, 48 months, billed every 48 months | ucf-a-4-48-48 | ucf-a-4-48-48 | Yes | |
API Access, 48 months, billed every 48 months | ucf-a-5-48-48 | ucf-a-5-48-48 | Yes | |
OEM API, 48 months, billed every 48 months | ucf-a-6-48-48 | ucf-a-6-48-48 | Yes | |
UCF Mapper, 48 months, billed every 48 months | ucf-a-9-48-48 | ucf-a-9-48-48 | Yes | |
Energy NERC+, 48 months, billed every 48 months | ucf-a-11-48-48 | ucf-a-11-48-48 | energy | No |
Alabama State Agencies, 48 months, billed every 48 months | ucf-a-12-48-48 | ucf-a-12-48-48 | stateAgencyAlabama | No |
California State Agencies, 48 months, billed every 48 months | ucf-a-13-48-48 | ucf-a-13-48-48 | stateAgencyCalifornia | No |
Texas State Agencies, 48 months, billed every 48 months | ucf-a-14-48-48 | ucf-a-14-48-48 | stateAgencyTexas | No |
New York State Agencies, 48 months, billed every 48 months | ucf-a-15-48-48 | ucf-a-15-48-48 | stateAgencyNewYork | No |
Colorado State Agencies, 48 months, billed every 48 months | ucf-a-16-48-48 | ucf-a-16-48-48 | stateAgencyColorado | No |
Arizona State Agencies, 48 months, billed every 48 months | ucf-a-17-48-48 | ucf-a-17-48-48 | stateAgencyArizona | No |
CCH Basic Subscription, 60 months, billed every 60 months - ucf-p-1-60-60
Name | Add-on Code | Accounting Code | Restriction | Implemented in Production |
|---|---|---|---|---|
Additional User, 60 months, billed every 60 months | ucf-a-2-60-60 | ucf-a-2-60-60 | Yes | |
Compliance Templates, 60 months, billed every 60 months | ucf-a-3-60-60 | ucf-a-3-60-60 | Yes | |
Custom Glossary, 60 months, billed every 60 months | ucf-a-4-60-60 | ucf-a-4-60-60 | Yes | |
API Access, 60 months, billed every 60 months | ucf-a-5-60-60 | ucf-a-5-60-60 | Yes | |
OEM API, 60 months, billed every 60 months | ucf-a-6-60-60 | ucf-a-6-60-60 | Yes | |
UCF Mapper, 60 months, billed every 60 months | ucf-a-9-60-60 | ucf-a-9-60-60 | Yes | |
Energy NERC+, 60 months, billed every 60 months | ucf-a-11-60-60 | ucf-a-11-60-60 | energy | No |
Alabama State Agencies, 60 months, billed every 60 months | ucf-a-12-60-60 | ucf-a-12-60-60 | stateAgencyAlabama | No |
California State Agencies, 60 months, billed every 60 months | ucf-a-13-60-60 | ucf-a-13-60-60 | stateAgencyCalifornia | No |
Texas State Agencies, 60 months, billed every 60 months | ucf-a-14-60-60 | ucf-a-14-60-60 | stateAgencyTexas | No |
New York State Agencies, 60 months, billed every 60 months | ucf-a-15-60-60 | ucf-a-15-60-60 | stateAgencyNewYork | No |
Colorado State Agencies, 60 months, billed every 60 months | ucf-a-16-60-60 | ucf-a-16-60-60 | stateAgencyColorado | No |
Arizona State Agencies, 60 months, billed every 60 months | ucf-a-17-60-60 | ucf-a-17-60-60 | stateAgencyArizona | No |
Restrictions: In order for customers to be able to use (via the UI or APIs) Authority Documents (or other entities) that are part of an entitled add-on with restriction, we have to add rows to the entity_entitlements table of the CCH database as a new Authority Document (or other targeted entities) is published. Adding a restriction to an entity will only prevent it from being directly accessed via API and will not prevent it from appearing inside of other responses. CCH only supports restrictions for Authority Documents at the moment.
Table structure for entity_entitlements:
Column | Type | Example Value(s) |
|---|---|---|
class_name | string |
|
entity_id | integer | The ID of the entity |
restriction | string |
|
Example:
To restrict Authority Document 1234 to Arizona, add the following to the entity_entitlements table:
class_name = Db\Entity\AuthorityDocument
entity_id = 1234
restriction = stateAgencyArizona