Agency bill plan summary
PolicyCenter supports the ability to view a summary of all the agency bill plans and their supported currencies. For information on how PolicyCenter gets agency bill plans from the billing systems, see Application Guide
Use the following endpoint to view the agency bill plan summary:
- GET
/admin/v1/agency-bill-plan-summaries
For example, the following query returns a list of agency bill plans:
Command
GET /admin/v1/agency-bill-plan-summariesResponse Payload
{
"count": 25,
"data": [
{
"attributes": {
"currencies": [
{
"code": "gbp",
"name": "GBP"
},
{
"code": "cad",
"name": "CAD"
},
{
"code": "rub",
"name": "RUB"
}
],
"id": "pctest:0(325)",
"name": "Standard Agency Bill Plan 0 (CAD, GBP, RUB)"
}
},
{
"attributes": {
"currencies": [
{
"code": "eur",
"name": "EUR"
},
{
"code": "gbp",
"name": "GBP"
},
{
"code": "rub",
"name": "RUB"
},
{
"code": "jpy",
"name": "JPY"
}
],
"id": "pctest:0(1625)",
"name": "Standard Agency Bill Plan 0 (EUR, JPY, GBP, RUB)"
}
},
...
],
"links": {
"first": {
"href": "/admin/v1/agency-bill-plan-summaries",
"methods": [
"get"
]
},
"next": {
"href": "/admin/v1/agency-bill-plan-summaries?pageOffset=25",
"methods": [
"get"
]
},
"self": {
"href": "/admin/v1/agency-bill-plan-summaries",
"methods": [
"get"
]
}
}
}