Skip to main content
GET
/
v1
/
policies
/
{policy_id}
/
premiums
cURL
curl --request GET \
  --url https://dev-api-cj-agc-vie.fnstack.dev/v1/policies/{policy_id}/premiums \
  --header 'x-api-key: <api-key>'
[
  {
    "order": 1,
    "status": "PENDING",
    "currency": "XAF",
    "amount_due": 1000,
    "premium_id": "policy_2c1x7V4r47ynM4RABVm1Co0UKkG",
    "period_end": "2024-07-17",
    "amount_paid": 1600,
    "period_start": "2024-06-17",
    "total_amount": 1600,
    "amount_remaining": 1600,
    "description": "<string>"
  }
]

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
policy_id
string
required
Minimum string length: 1
Example:

"policy_2c1x7V4r47ynM4RABVm1Co0UKkG"

Query Parameters

​
status
enum<string>
default:PENDING
Available options:
OVERDUE,
PAID,
PARTIALLY_PAID,
PENDING,
SUSPENDED
Example:

"PENDING"

Response

​
order
number
required
Example:

1

​
status
enum<string>
required
Available options:
OVERDUE,
PAID,
PARTIALLY_PAID,
PENDING,
SUSPENDED
Example:

"PENDING"

​
currency
enum<string>
required
Available options:
EUR,
XAF
Example:

"XAF"

​
amount_due
number
required
Example:

1000

​
premium_id
string
required
Minimum string length: 1
Example:

"policy_2c1x7V4r47ynM4RABVm1Co0UKkG"

​
period_end
string
required
Minimum string length: 1
Example:

"2024-07-17"

​
amount_paid
number
required
Example:

1600

​
period_start
string
required
Minimum string length: 1
Example:

"2024-06-17"

​
total_amount
number
required
Example:

1600

​
amount_remaining
number
required
Example:

1600

​
description
string