POST api/IdealRPay/createPlan

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
period	string	None.
interval	integer	None.
item	PlanDetailRequest	None.
notes	Collection of Object	None.

Request Formats

application/json, text/json

Sample:

{
  "period": "sample string 1",
  "interval": 2,
  "item": {
    "name": "sample string 1",
    "description": "sample string 2",
    "amount": 3,
    "currency": "sample string 4"
  },
  "notes": [
    {},
    {}
  ]
}

application/xml, text/xml

Sample:

<clsPlanRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LiveTextBooksModel.Entity">
  <interval>2</interval>
  <item>
    <amount>3</amount>
    <currency>sample string 4</currency>
    <description>sample string 2</description>
    <name>sample string 1</name>
  </item>
  <notes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </notes>
  <period>sample string 1</period>
</clsPlanRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

clsPlanResponse

Name	Type	Additional information
id	string	None.
entity	string	None.
interval	integer	None.
period	string	None.
item	PlanDetail	None.
notes	Collection of Object	None.
created_at	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "id": "sample string 1",
  "entity": "sample string 2",
  "interval": 3,
  "period": "sample string 4",
  "item": {
    "id": "sample string 1",
    "active": true,
    "name": "sample string 3",
    "description": "sample string 4",
    "amount": 5,
    "unit_amount": 6,
    "currency": "sample string 7",
    "type": "sample string 8",
    "unit": {},
    "tax_inclusive": true,
    "hsn_code": {},
    "sac_code": {},
    "tax_rate": {},
    "tax_id": {},
    "tax_group_id": {},
    "created_at": 16,
    "updated_at": 17
  },
  "notes": [
    {},
    {}
  ],
  "created_at": 5
}

application/xml, text/xml

Sample:

<clsPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LiveTextBooksModel.Entity">
  <created_at>5</created_at>
  <entity>sample string 2</entity>
  <id>sample string 1</id>
  <interval>3</interval>
  <item>
    <active>true</active>
    <amount>5</amount>
    <created_at>16</created_at>
    <currency>sample string 7</currency>
    <description>sample string 4</description>
    <hsn_code />
    <id>sample string 1</id>
    <name>sample string 3</name>
    <sac_code />
    <tax_group_id />
    <tax_id />
    <tax_inclusive>true</tax_inclusive>
    <tax_rate />
    <type>sample string 8</type>
    <unit />
    <unit_amount>6</unit_amount>
    <updated_at>17</updated_at>
  </item>
  <notes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </notes>
  <period>sample string 4</period>
</clsPlanResponse>