Get Plans

Endpoint:

This endpoint will return a list of billing plans and packs that are available for the selected group. Details of each plan and pack will be returned also.

Information Circle

Plans vs Packs: Plans are recurring billing subscriptions (monthly/annual) that provide a base allocation of documents. Packs are one-time purchases that add additional document capacity to your existing plan.

POST Parameters

ParameterRequiredValueDescription
api_key{key}An API key that has access to the resource you want to query for
group_id{integer}The group you wish to get the usage details for. If not submitted then the group of the API key will be used.
plan_id{integer}Get information about a specific plan id
pack_id{integer}Get information about a specific pack id
is_parent{integer}Filter plans based on parent/child group relationships

Response Information

ElementDescription
<status>A status code in response to the operation
<message>Additional information about the operation – human readable
<plan>Container for billing plan information (can appear multiple times)
<plan>→<id>The unique ID of the billing plan
<plan>→<plan_name>The name of the billing plan
<plan>→<plan_type>The type of plan (e.g., Monthly, Annual)
<plan>→<allowed_documents>The number of documents allowed in this plan
<plan>→<group_id>The ID of the group this plan is associated with
<plan>→<price>The retail price of the plan
<plan>→<wholesale_price>The wholesale price of the plan (for resellers)
<pack>Container for booster pack information (can appear multiple times)
<pack>→<id>The unique ID of the booster pack
<pack>→<pack_name>The name of the booster pack
<pack>→<allowed_documents>The number of additional documents provided by this pack
<pack>→<group_id>The ID of the group this pack is associated with
<pack>→<price>The retail price of the pack
<pack>→<wholesale_price>The wholesale price of the pack (for resellers)

Example

Sample Request

POST https://api-app.xtracta.com/v1/plans-packs HTTP/1.1
api_key=123

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<billings_response>
    <status>200</status>
    <message>The request has been successfully processed</message>
    <plan>
        <id>1</id>
        <plan_name>Plan A</plan_name>
        <plan_type>Monthly</plan_type>
        <allowed_documents>250</allowed_documents>
        <group_id>481</group_id>
        <price>155</price>
        <wholesale_price>15</wholesale_price>
    </plan>
    <plan>
        <id>2</id>
        <plan_name>Plan B</plan_name>
        <plan_type>Monthly</plan_type>
        <allowed_documents>500</allowed_documents>
        <group_id>481</group_id>
        <price>195</price>
        <wholesale_price>30</wholesale_price>
    </plan>
    <plan>
        <id>3</id>
        <plan_name>Plan C</plan_name>
        <plan_type>Monthly</plan_type>
        <allowed_documents>1000</allowed_documents>
        <group_id>481</group_id>
        <price>250</price>
        <wholesale_price>50</wholesale_price>
    </plan>
    <plan>
        <id>4</id>
        <plan_name>Plan D</plan_name>
        <plan_type>Monthly</plan_type>
        <allowed_documents>5000</allowed_documents>
        <group_id>481</group_id>
        <price>450</price>
        <wholesale_price>100</wholesale_price>
    </plan>
    <pack>
        <id>1</id>
        <pack_name>Booster 100</pack_name>
        <allowed_documents>100</allowed_documents>
        <group_id>481</group_id>
        <price>195</price>
        <wholesale_price>30</wholesale_price>
    </pack>
</billings_response>

Schema Definition

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">

  <xs:simpleType name="ConfidenceType">
    <xs:union>
      <xs:simpleType>
        <xs:restriction base="xs:integer">
          <xs:minInclusive value="0"/>
          <xs:maxInclusive value="100"/>
        </xs:restriction>
      </xs:simpleType>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value=""/>
        </xs:restriction>
      </xs:simpleType>
    </xs:union>
  </xs:simpleType>

  <xs:complexType name="PlanType">
    <xs:sequence>
      <xs:element name="id" type="xs:positiveInteger"/>
      <xs:element name="plan_name" type="xs:string"/>
      <xs:element name="plan_type" type="xs:string"/>
      <xs:element name="allowed_documents" type="xs:nonNegativeInteger"/>
      <xs:element name="group_id" type="xs:positiveInteger" minOccurs="0"/>
      <xs:element name="price" type="xs:decimal"/>
      <xs:element name="currency" type="xs:string"/>
      <xs:element name="status" type="xs:string" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="PackType">
    <xs:sequence>
      <xs:element name="id" type="xs:positiveInteger"/>
      <xs:element name="pack_name" type="xs:string"/>
      <xs:element name="allowed_documents" type="xs:nonNegativeInteger"/>
      <xs:element name="group_id" type="xs:positiveInteger" minOccurs="0"/>
      <xs:element name="price" type="xs:decimal"/>
    </xs:sequence>
  </xs:complexType>

  <xs:element name="billings_response">
    <xs:complexType>
      <xs:sequence>
      <xs:element name="status" type="xs:string" minOccurs="0"/>
      <xs:element name="message" type="xs:string"/>
      <xs:element name="plan" type="PlanType" maxOccurs="unbounded"/>
      <xs:element name="pack" type="PackType" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

</xs:schema>