Skip to main content
POST
/
subscription
/
bill
Get Payment Plans
curl --request POST \
  --url https://apigw.bienport.com/api/subscription/bill \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'OrganizationId: <organizationid>' \
  --data '{
  "organizationId": 12312,
  "subscriptionId": 12342,
  "billId": 1234234,
  "monthFilter": "1"
}'
[
  {
    "id": "884386",
    "href": "http://example.com",
    "billDate": "2020-07-06T00:00:00.000Z",
    "billNo": "",
    "paymentDueDate": "2020-07-06T00:00:00.000Z",
    "paymentDate": "2020-07-06T00:00:00.000Z",
    "amountDue": {
      "unit": "TL",
      "value": 200
    },
    "state": "paid"
  }
]

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
required

Organization Id

Example:

12312

​
subscriptionId
integer
required

subscription id

Example:

12342

​
billId
integer

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
object

A base / value business entity used to represent money

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

"paid"