POST api/IdealRPay/createSubscription

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
plan_id	string	None.
total_count	integer	None.
quantity	integer	None.
customer_notify	integer	None.
start_at	integer	None.
expire_by	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "plan_id": "sample string 1",
  "total_count": 2,
  "quantity": 3,
  "customer_notify": 4,
  "start_at": 5,
  "expire_by": 6
}

application/xml, text/xml

Sample:

<clsSubscriptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LiveTextBooksModel.Entity">
  <customer_notify>4</customer_notify>
  <expire_by>6</expire_by>
  <plan_id>sample string 1</plan_id>
  <quantity>3</quantity>
  <start_at>5</start_at>
  <total_count>2</total_count>
</clsSubscriptionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

clsSubscription

Name	Type	Additional information
id	string	None.
entity	string	None.
plan_id	string	None.
status	string	None.
current_start	Object	None.
current_end	Object	None.
ended_at	Object	None.
quantity	integer	None.
notes	Notes	None.
charge_at	integer	None.
start_at	integer	None.
end_at	integer	None.
auth_attempts	integer	None.
total_count	integer	None.
paid_count	integer	None.
customer_notify	boolean	None.
created_at	integer	None.
expire_by	integer	None.
short_url	string	None.
has_scheduled_changes	boolean	None.
change_scheduled_at	Object	None.
remaining_count	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "id": "sample string 1",
  "entity": "sample string 2",
  "plan_id": "sample string 3",
  "status": "sample string 4",
  "current_start": {},
  "current_end": {},
  "ended_at": {},
  "quantity": 8,
  "notes": {
    "notes_key_1": "sample string 1",
    "notes_key_2": "sample string 2"
  },
  "charge_at": 9,
  "start_at": 10,
  "end_at": 11,
  "auth_attempts": 12,
  "total_count": 13,
  "paid_count": 14,
  "customer_notify": true,
  "created_at": 16,
  "expire_by": 17,
  "short_url": "sample string 18",
  "has_scheduled_changes": true,
  "change_scheduled_at": {},
  "remaining_count": 21
}

application/xml, text/xml

Sample:

<clsSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LiveTextBooksModel.Entity">
  <auth_attempts>12</auth_attempts>
  <change_scheduled_at />
  <charge_at>9</charge_at>
  <created_at>16</created_at>
  <current_end />
  <current_start />
  <customer_notify>true</customer_notify>
  <end_at>11</end_at>
  <ended_at />
  <entity>sample string 2</entity>
  <expire_by>17</expire_by>
  <has_scheduled_changes>true</has_scheduled_changes>
  <id>sample string 1</id>
  <notes>
    <notes_key_1>sample string 1</notes_key_1>
    <notes_key_2>sample string 2</notes_key_2>
  </notes>
  <paid_count>14</paid_count>
  <plan_id>sample string 3</plan_id>
  <quantity>8</quantity>
  <remaining_count>21</remaining_count>
  <short_url>sample string 18</short_url>
  <start_at>10</start_at>
  <status>sample string 4</status>
  <total_count>13</total_count>
</clsSubscription>