Skip to main content
POST
Get Payment Plans

Headers

Authorization
string
required

Access Token

OrganizationId
string
required

Organization ID

Body

application/json

paymentPlanRequest

Request Model for Get Payment Plans by organization id and subscription Id

organizationId
integer<int64>
required

Organization Id

Example:

12312

subscriptionId
integer<int64>
required

subscription id

Example:

12342

billId
integer<int64>

bill id[Optional]

Example:

1234234

monthFilter
enum<string>

Month Filter[Optional] default value = 6

Available options:
1,
3,
6,
12,
24
Example:

"1"

Response

Get payment plan(CustomerBill). (Return List if more than one.)

id
string
Example:

"884386"

href
string
Example:

"http://example.com"

billDate
string
Example:

"2020-07-06T00:00:00.000Z"

billNo
string
Example:

""

paymentDueDate
string
Example:

"2020-07-06T00:00:00.000Z"

paymentDate
string
Example:

"2020-07-06T00:00:00.000Z"

amountDue
Money · object

A base / value business entity used to represent money

state
enum<string>
Available options:
paid,
settled
Example:

"paid"