POST Billing

Request Information

URI Parameters

None.

Body Parameters

BillingRequest
Name Description Type Additional information
billing_plan

BillingPlan

None.

bill_sequence

Collection of BillSequence

None.

additional_data

Collection of AdditionalData

None.

Request Formats

application/json, text/json

Sample:
{
  "billing_plan": {
    "abid": 1,
    "customer_id": "sample string 1",
    "token": "sample string 2",
    "plan_type": 1,
    "schedule_type": "sample string 3",
    "amount": 1.0,
    "start_date": "2024-03-28T14:59:44.283713+00:00",
    "periodicity": 1,
    "end_date": "2024-03-28T14:59:44.283713+00:00",
    "end_type": 1,
    "no_of_payments": 1,
    "reference_id": "sample string 4",
    "name": "sample string 5",
    "active": true,
    "billing_mode": "sample string 6",
    "max_retry": 7,
    "bill_day": 1,
    "ref_token_id": 1,
    "email_receipt": true,
    "merchant_terminal_id": 1,
    "update_active_status": true
  },
  "bill_sequence": [
    {
      "id": 1,
      "reference_id": "sample string 2",
      "sequence_number": 1,
      "amount": 1.0,
      "schedule_date": "2024-03-28T14:59:44.2887132+00:00"
    },
    {
      "id": 1,
      "reference_id": "sample string 2",
      "sequence_number": 1,
      "amount": 1.0,
      "schedule_date": "2024-03-28T14:59:44.2887132+00:00"
    }
  ],
  "additional_data": [
    {
      "id": "sample string 1",
      "value": "sample string 2"
    },
    {
      "id": "sample string 1",
      "value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<BillingRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <billing_plan>
    <abid>1</abid>
    <customer_id>sample string 1</customer_id>
    <token>sample string 2</token>
    <plan_type>1</plan_type>
    <schedule_type>sample string 3</schedule_type>
    <amount>1</amount>
    <start_date>2024-03-28T14:59:44.283713+00:00</start_date>
    <periodicity>1</periodicity>
    <end_date>2024-03-28T14:59:44.283713+00:00</end_date>
    <end_type>1</end_type>
    <no_of_payments>1</no_of_payments>
    <reference_id>sample string 4</reference_id>
    <name>sample string 5</name>
    <active>true</active>
    <billing_mode>sample string 6</billing_mode>
    <max_retry>7</max_retry>
    <bill_day>1</bill_day>
    <ref_token_id>1</ref_token_id>
    <email_receipt>true</email_receipt>
    <merchant_terminal_id>1</merchant_terminal_id>
    <update_active_status>true</update_active_status>
  </billing_plan>
  <bill_sequence>
    <BillSequence>
      <id>1</id>
      <reference_id>sample string 2</reference_id>
      <sequence_number>1</sequence_number>
      <amount>1</amount>
      <schedule_date>2024-03-28T14:59:44.2887132+00:00</schedule_date>
    </BillSequence>
    <BillSequence>
      <id>1</id>
      <reference_id>sample string 2</reference_id>
      <sequence_number>1</sequence_number>
      <amount>1</amount>
      <schedule_date>2024-03-28T14:59:44.2887132+00:00</schedule_date>
    </BillSequence>
  </bill_sequence>
  <additional_data>
    <AdditionalData>
      <id>sample string 1</id>
      <value>sample string 2</value>
    </AdditionalData>
    <AdditionalData>
      <id>sample string 1</id>
      <value>sample string 2</value>
    </AdditionalData>
  </additional_data>
</BillingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
Name Description Type Additional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.