GET api/Billing/NewBillingStructure

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
BillingStructureID	integer	None.
BillingStructureType	BillingStructureType	None.
BillingStructurePeriod	BillingStructurePeriod	None.
CustomSchedule	BillingPeriodSettings	None.
Name	string	None.
IncludesGSTInFee	boolean	None.
ChargeForRUFTxns	boolean	None.
ChargeForReconciledTxns	boolean	None.
IsDeleted	boolean	None.
GSTPercentage	decimal number	None.
Tiers	Collection of BillingStructureTier	None.

Response Formats

application/json, text/json

Sample:

{
  "BillingStructureID": 1,
  "BillingStructureType": {
    "BillingStructureTypeID": 1,
    "Name": "sample string 2"
  },
  "BillingStructurePeriod": {
    "BillingStructurePeriodID": 1,
    "Name": "sample string 2"
  },
  "CustomSchedule": {
    "BillingStructureID": 1,
    "DailyStartHours": "sample string 2",
    "DailyStartMins": "sample string 3",
    "DailyTimeZoneID": 4,
    "WeeklyDayOfWeek": 5,
    "WeeklyStartHours": "sample string 6",
    "WeeklyStartMins": "sample string 7",
    "WeeklyTimeZoneID": 8,
    "MonthlyWeekOfMonth": 9,
    "MonthlyDayOfWeek": 10,
    "MonthlyStartHours": "sample string 11",
    "MonthlyStartMins": "sample string 12",
    "MonthlyTimeZoneID": 13,
    "YearlyRunDate": "2026-04-07T20:08:36.5070773+10:00",
    "YearlyStartHours": "sample string 15",
    "YearlyStartMins": "sample string 16",
    "YearlyTimeZoneID": 17
  },
  "Name": "sample string 2",
  "IncludesGSTInFee": true,
  "ChargeForRUFTxns": true,
  "ChargeForReconciledTxns": true,
  "IsDeleted": true,
  "GSTPercentage": 7.1,
  "Tiers": [
    {
      "BillingStructureID": 1,
      "TierID": 2,
      "StartTxnCount": 3,
      "EndTxnCount": 4,
      "AppliesToNewTxnsOnly": true,
      "BillingStructureType": {
        "BillingStructureTypeID": 1,
        "Name": "sample string 2"
      },
      "Percentage": {
        "BillingStructureID": 1,
        "TierID": 2,
        "Percentage": 3.1,
        "FixedFee": 4.1,
        "MaximumFee": 5.1,
        "MinimumFee": 6.1
      },
      "FixedPrice": {
        "BillingStructureID": 1,
        "TierID": 2,
        "FixedAmount": 3.1,
        "CurrencyCode": "sample string 4"
      },
      "PeriodLimit": {
        "BillingStructureID": 1,
        "TierID": 2,
        "MinimumFees": 3.1,
        "MaximumFees": 4.1
      }
    },
    {
      "BillingStructureID": 1,
      "TierID": 2,
      "StartTxnCount": 3,
      "EndTxnCount": 4,
      "AppliesToNewTxnsOnly": true,
      "BillingStructureType": {
        "BillingStructureTypeID": 1,
        "Name": "sample string 2"
      },
      "Percentage": {
        "BillingStructureID": 1,
        "TierID": 2,
        "Percentage": 3.1,
        "FixedFee": 4.1,
        "MaximumFee": 5.1,
        "MinimumFee": 6.1
      },
      "FixedPrice": {
        "BillingStructureID": 1,
        "TierID": 2,
        "FixedAmount": 3.1,
        "CurrencyCode": "sample string 4"
      },
      "PeriodLimit": {
        "BillingStructureID": 1,
        "TierID": 2,
        "MinimumFees": 3.1,
        "MaximumFees": 4.1
      }
    }
  ]
}

application/xml, text/xml

Sample:

<BillingStructure xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
  <BillingStructureID>1</BillingStructureID>
  <BillingStructurePeriod>
    <BillingStructurePeriodID>1</BillingStructurePeriodID>
    <Name>sample string 2</Name>
  </BillingStructurePeriod>
  <BillingStructureType>
    <BillingStructureTypeID>1</BillingStructureTypeID>
    <Name>sample string 2</Name>
  </BillingStructureType>
  <ChargeForRUFTxns>true</ChargeForRUFTxns>
  <ChargeForReconciledTxns>true</ChargeForReconciledTxns>
  <CustomSchedule>
    <BillingStructureID>1</BillingStructureID>
    <DailyStartHours>sample string 2</DailyStartHours>
    <DailyStartMins>sample string 3</DailyStartMins>
    <DailyTimeZoneID>4</DailyTimeZoneID>
    <MonthlyDayOfWeek>10</MonthlyDayOfWeek>
    <MonthlyStartHours>sample string 11</MonthlyStartHours>
    <MonthlyStartMins>sample string 12</MonthlyStartMins>
    <MonthlyTimeZoneID>13</MonthlyTimeZoneID>
    <MonthlyWeekOfMonth>9</MonthlyWeekOfMonth>
    <WeeklyDayOfWeek>5</WeeklyDayOfWeek>
    <WeeklyStartHours>sample string 6</WeeklyStartHours>
    <WeeklyStartMins>sample string 7</WeeklyStartMins>
    <WeeklyTimeZoneID>8</WeeklyTimeZoneID>
    <YearlyRunDate>2026-04-07T20:08:36.5070773+10:00</YearlyRunDate>
    <YearlyStartHours>sample string 15</YearlyStartHours>
    <YearlyStartMins>sample string 16</YearlyStartMins>
    <YearlyTimeZoneID>17</YearlyTimeZoneID>
  </CustomSchedule>
  <GSTPercentage>7.1</GSTPercentage>
  <IncludesGSTInFee>true</IncludesGSTInFee>
  <IsDeleted>true</IsDeleted>
  <Name>sample string 2</Name>
  <Tiers>
    <BillingStructureTier>
      <AppliesToNewTxnsOnly>true</AppliesToNewTxnsOnly>
      <BillingStructureID>1</BillingStructureID>
      <BillingStructureType>
        <BillingStructureTypeID>1</BillingStructureTypeID>
        <Name>sample string 2</Name>
      </BillingStructureType>
      <EndTxnCount>4</EndTxnCount>
      <FixedPrice>
        <BillingStructureID>1</BillingStructureID>
        <CurrencyCode>sample string 4</CurrencyCode>
        <FixedAmount>3.1</FixedAmount>
        <TierID>2</TierID>
      </FixedPrice>
      <Percentage>
        <BillingStructureID>1</BillingStructureID>
        <FixedFee>4.1</FixedFee>
        <MaximumFee>5.1</MaximumFee>
        <MinimumFee>6.1</MinimumFee>
        <Percentage>3.1</Percentage>
        <TierID>2</TierID>
      </Percentage>
      <PeriodLimit>
        <BillingStructureID>1</BillingStructureID>
        <MaximumFees>4.1</MaximumFees>
        <MinimumFees>3.1</MinimumFees>
        <TierID>2</TierID>
      </PeriodLimit>
      <StartTxnCount>3</StartTxnCount>
      <TierID>2</TierID>
    </BillingStructureTier>
    <BillingStructureTier>
      <AppliesToNewTxnsOnly>true</AppliesToNewTxnsOnly>
      <BillingStructureID>1</BillingStructureID>
      <BillingStructureType>
        <BillingStructureTypeID>1</BillingStructureTypeID>
        <Name>sample string 2</Name>
      </BillingStructureType>
      <EndTxnCount>4</EndTxnCount>
      <FixedPrice>
        <BillingStructureID>1</BillingStructureID>
        <CurrencyCode>sample string 4</CurrencyCode>
        <FixedAmount>3.1</FixedAmount>
        <TierID>2</TierID>
      </FixedPrice>
      <Percentage>
        <BillingStructureID>1</BillingStructureID>
        <FixedFee>4.1</FixedFee>
        <MaximumFee>5.1</MaximumFee>
        <MinimumFee>6.1</MinimumFee>
        <Percentage>3.1</Percentage>
        <TierID>2</TierID>
      </Percentage>
      <PeriodLimit>
        <BillingStructureID>1</BillingStructureID>
        <MaximumFees>4.1</MaximumFees>
        <MinimumFees>3.1</MinimumFees>
        <TierID>2</TierID>
      </PeriodLimit>
      <StartTxnCount>3</StartTxnCount>
      <TierID>2</TierID>
    </BillingStructureTier>
  </Tiers>
</BillingStructure>