Policy period archive summaries

You can archive a policy period that meets archiving eligibility criteria. For example, a policy period must be closed for a predefined amount of time and have no financial activity during that time to be archived. Archiving old policy periods enhances BillingCenter performance by reducing the size of the active database.

You can view data for archived policy periods. To view a summary of archived policy periods, use the following endpoint:

  • GET /accounts/{accountId}/policies/{policyId}/policy-periods/{policyPeriodId}/archive-summaries
  • GET /accounts/{accountId}/policies/{policyId}/policy-periods/{policyPeriodId}/archive-summaries/{policyPeriodArchiveSummaryId}

There is a one-to-one relationship between the policy period archive summary and the archived policy period. Therefore, the collection endpoint returns only one resource.

Policy period archive summaries are objects that contain financial details of the policy period and other data points. This includes the following:

  • delinquencyCount: The number of delinquencies on the policy period
  • paid: The amount that was paid on the policy period
  • otherCharges: The sum of the non-premium charges on the policy period
  • premiumCharges: The sum of the premium charges on the policy period
  • writtenOff: The amount on the policy that was written off

For example, the following GET request retrieves an policy period archive summary for a policy period:

Command 
GET /billing/v1/accounts/bc:ShTMXgeDdnpi--NhqkAyj/policies/bc:SaYe6tLl6e_um4P1lrjq0/policy-periods/bc:SSBBC6a3LJdMzh-83z0Va/archive-summaries
Response 
{
    "count": 1,
    "data": [
        {
            "attributes": {
                "delinquencyCount": 0,
                "id": "bc:S8fgVpm6LD-Gv7MTTdIoh",
                "otherCharges": {
                    "amount": "0.00",
                    "currency": "usd"
                },
                "paid": {
                    "amount": "1200.00",
                    "currency": "usd"
                },
                "premiumCharges": {
                    "amount": "1200.00",
                    "currency": "usd"
                },
                "writtenOff": {
                    "amount": "0.00",
                    "currency": "usd"
                }
            },
            "checksum": "0",
            "links": {
                "self": {
                    "href": "/billing/v1/accounts/bc:ShTMXgeDdnpi--NhqkAyj/policies/bc:SaYe6tLl6e_um4P1lrjq0/policy-periods/bc:SSBBC6a3LJdMzh-83z0Va/archive-summaries/bc:S8fgVpm6LD-Gv7MTTdIoh",
                    "methods": [
                        "get"
                    ]
                }
            }
        }
    ],
    "links": {
        "first": {
            "href": "/billing/v1/accounts/bc:ShTMXgeDdnpi--NhqkAyj/policies/bc:SaYe6tLl6e_um4P1lrjq0/policy-periods/bc:SSBBC6a3LJdMzh-83z0Va/archive-summaries",
            "methods": [
                "get"
            ]
        },
        "self": {
            "href": "/billing/v1/accounts/bc:ShTMXgeDdnpi--NhqkAyj/policies/bc:SaYe6tLl6e_um4P1lrjq0/policy-periods/bc:SSBBC6a3LJdMzh-83z0Va/archive-summaries",
            "methods": [
                "get"
            ]
        }
    }
}
Note: If an archived policy has been retrieved, the endpoint returns no data.