List pricing schedules of an account

GET

accounts

{account_id}

pricing_schedules

curl --request GET \
  --url https://api.togai.com/accounts/{account_id}/pricing_schedules \
  --header 'Authorization: <authorization>'

{
  "data": [
    {
      "pricePlanId": "pp.bs8932bf328"
    },
    {
      "startDate": "2080-10-04T00:00:00Z",
      "endDate": "2099-10-04T00:00:00Z",
      "pricePlanDetails": {
        "supportedCurrencies": [
          "USD"
        ],
        "activeCurrencies": [
          "USD"
        ],
        "pricingCycleConfig": {
          "interval": "MONTHLY",
          "startOffset": {
            "dayOffset": "4",
            "monthOffset": "NIL"
          },
          "gracePeriod": 3
        },
        "usageRateCards": [
          {
            "displayName": "Local Rides",
            "usageMeterId": "um.1zYnCiM9Bpg.1zYn",
            "ratePlan": {
              "pricingModel": "TIERED",
              "slabs": [
                {
                  "order": 1,
                  "startAfter": 0,
                  "priceType": "FLAT"
                }
              ]
            },
            "rateValues": [
              {
                "currency": "USD",
                "slabRates": [
                  {
                    "rate": 40,
                    "order": 1
                  }
                ]
              }
            ]
          }
        ],
        "fixedFeeRateCards": [
          {
            "id": "addon.2077efUBMXo.DyzlZ",
            "displayName": "Maintenance",
            "rateValues": [
              {
                "currency": "USD",
                "rate": 10
              }
            ]
          }
        ],
        "minimumCommitment": {
          "displayName": "Minimum Commitment",
          "rateValues": [
            {
              "currency": "USD",
              "rate": 10
            }
          ]
        }
      }
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
}

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

account_id

string

required

account_id corresponding to an account

Query Parameters

nextToken

string

pageSize

number

start_date

string

end_date

string

Response

200 - application/json

data

object[]

data.id

string

required

data.pricePlanDetails

object

data.pricePlanDetails.supportedCurrencies

string[]

required

data.pricePlanDetails.activeCurrencies

string[]

required

data.pricePlanDetails.pricingCycleConfig

object

Represents configurations related to pricing cycle

data.pricePlanDetails.pricingCycleConfig.interval

enum<string>

required

Interval field allow you to define the billing interval you would like to set

Available options:

WEEKLY,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

ANNUALLY

data.pricePlanDetails.pricingCycleConfig.startOffset

object

Represents the start of pricing cycle in terms of

dayOffset - number of days from beginning of week / month and
monthOffset - number of months from beginning of interval (quarter, half-year or year) Note: If a day with offset doesn't exist for a month, closest previous day is considered Examples: WEEKLY -
{dayOffset: 1, monthOffset: NIL} - First day of every week (Monday)
{dayOffset: 3, monthOffset: NIL} - 3rd day of every week (Wednesday)
{dayOffset: LAST, monthOffset: NIL} - Last day of every week (Sunday) MONTHLY -
{dayOffset: 1, monthOffset: NIL} - First day of every month
{dayOffset: 12, monthOffset: NIL} - 12th of every month
{dayOffset: 28, monthOffset: NIL} - 28th of every month. i.e, 28th of Jan, 28th of Feb, ...
{dayOffset: 30, monthOffset: NIL} - 30th of every month. i.e, 28th of Jan, 28th of Feb, ...
{dayOffset: LAST, monthOffset: NIL} - Last day of every month. i.e, 31st of Jan, 28th of Feb, ... QUARTERLY
{dayOffset: 15, monthOffset: FIRST} - 15th Jan, 15th Apr, 15th Jul and 15th Oct
{dayOffset: 15, monthOffset: 2} - 15th Feb, 15th May, 15th Aug and 15th Nov
{dayOffset: 15, monthOffset: LAST} - 15th Mar, 15th Jun, 15th Sep and 15th Dec
{dayOffset: LAST, monthOffset: FIRST} - 31st Jan, 30th Apr, 30th Jul and 31th Oct HALF_YEARLY
{dayOffset: 15, monthOffset: FIRST} - 15th Jan and 15th Jul
{dayOffset: 15, monthOffset: 4} - 15th Apr and 15th Oct
{dayOffset: 15, monthOffset: LAST} - 15th Jun and 15th Dec ANNUALLY
{dayOffset: 15, monthOffset: FIRST} - 15th Jan
{dayOffset: 15, monthOffset: 1} - 15th Jan
{dayOffset: LAST, monthOffset: 2} - 29th Feb on Leap year, 28th otherwise
{dayOffset: 15, monthOffset: 8} - 15th Aug
{dayOffset: 15, monthOffset: LAST} - 15th Dec

data.pricePlanDetails.pricingCycleConfig.gracePeriod

integer

required

Togai allows you to ingest past dated events that will be processed by a pricing cycle till the end grace period. For example: Pricing cycle is Monthly from 1st to 30th and gracePeriod is 5 days which next month 1 to 5th date, you can ingest past dated events during this grace period.

data.pricePlanDetails.pricingCycleConfig.anniversaryCycle

boolean

Togai calculates the startOffsets based on the date of association instead of requiring from the user and these offsets will be applied as an override if this flag is enabled. Examples: WEEKLY -

23/10/2023 (Monday) - {dayOffset: 1, monthOffset: NIL}
25/10/2023 (Wednesday) - {dayOffset: 3, monthOffset: NIL}
29/10/2023 (Sunday) - {dayOffset: 7, monthOffset: NIL} MONTHLY -
1st Oct - {dayOffset: 1, monthOffset: NIL}
12th Oct - {dayOffset: 12, monthOffset: NIL}
28th Oct - {dayOffset: 28, monthOffset: NIL}
30th Oct - {dayOffset: 30, monthOffset: NIL}
31th Oct - {dayOffset: 31, monthOffset: NIL} QUARTERLY
15th Jan, 15th Apr, 15th Jul and 15th Oct - {dayOffset: 15, monthOffset: 1}
15th Feb, 15th May, 15th Aug and 15th Nov - {dayOffset: 15, monthOffset: 2}
15th Mar, 15th Jun, 15th Sep and 15th Dec - {dayOffset: 15, monthOffset: 3} HALF_YEARLY
15th Jan and 15th Jul - {dayOffset: 15, monthOffset: 1}
15th Apr and 15th Oct - {dayOffset: 15, monthOffset: 4}
15th Jun and 15th Dec - {dayOffset: 15, monthOffset: 6} ANNUALLY
15th Jan - {dayOffset: 15, monthOffset: 1}
29th Feb on Leap year - {dayOffset: 29, monthOffset: 2}
28th Feb - {dayOffset: 28, monthOffset: 2}
15th Aug - {dayOffset: 15, monthOffset: 8}
15th Dec - {dayOffset: 15, monthOffset: 12}

data.pricePlanDetails.usageRateCards

object[]

data.pricePlanDetails.fixedFeeRateCards

object[]

data.pricePlanDetails.licenseRateCards

object[]

data.pricePlanDetails.licenseRateCards.id

string

required

Unique Identifier of the attached AddOn

data.pricePlanDetails.licenseRateCards.displayName

string

Name of the attached AddOn

data.pricePlanDetails.licenseRateCards.tag

string

A tag string to group licenseRateCards

data.pricePlanDetails.licenseRateCards.invoiceTiming

enum<string>

If IN_ADVANCE, the fixed fee will be invoiced in the previous billing cycle. If IN_ARREARS, the fixed fee will be invoiced in the current billing cycle.

Available options:

IN_ADVANCE,

IN_ARREARS

data.pricePlanDetails.licenseRateCards.enableProration

boolean

required

data.pricePlanDetails.licenseRateCards.config

object

data.pricePlanDetails.licenseRateCards.ratePlan

object

required

Contains all rate related configurations

data.pricePlanDetails.licenseRateCards.rateValues

object[]

required

data.pricePlanDetails.licenseRateCards.proratedRefundMode

enum<string>

Available options:

NONE,

CREDITS,

PAYMENT

data.pricePlanDetails.billingEntitlementRateCards

object[]

data.pricePlanDetails.billingEntitlementRateCards.featureId

string

required

data.pricePlanDetails.billingEntitlementRateCards.featureConfigs

object[]

required

data.pricePlanDetails.billingEntitlementRateCards.tag

string

A tag string to group rate cards

data.pricePlanDetails.billingEntitlementRateCards.invoiceTiming

enum<string>

required

If IN_ADVANCE, the fixed fee will be invoiced in the previous billing cycle. If IN_ARREARS, the fixed fee will be invoiced in the current billing cycle.

Available options:

IN_ADVANCE,

IN_ARREARS

data.pricePlanDetails.billingEntitlementRateCards.displayName

string

Name your rate card, this will be used in invoice

data.pricePlanDetails.billingEntitlementRateCards.ratePlan

object

required

Contains all rate related configurations

data.pricePlanDetails.billingEntitlementRateCards.rateValues

object[]

required

data.pricePlanDetails.billingEntitlementRateCards.recurrenceConfig

object

data.pricePlanDetails.entitlementOverageRateCards

object[]

data.pricePlanDetails.entitlementOverageRateCards.featureId

string

required

Unique Identifier of the attached Feature

data.pricePlanDetails.entitlementOverageRateCards.displayName

string

Name to be displayed during invoice

data.pricePlanDetails.entitlementOverageRateCards.tag

string

A tag string to group rate cards

data.pricePlanDetails.entitlementOverageRateCards.maxQuantity

number

Maximum quantity allowed for the feature, if not specified, unlimited quantity is allowed

data.pricePlanDetails.entitlementOverageRateCards.ratePlan

object

required

Contains all rate related configurations

data.pricePlanDetails.entitlementOverageRateCards.rateValues

object[]

required

data.pricePlanDetails.entitlementOverageRateCards.billingConfig

object

Represents the billing config of the entitlement overage rate card. If not specified interval:1 and startOffset:0 is taken as default value

data.pricePlanDetails.minimumCommitment

object

data.pricePlanDetails.rateDetails

object

rate details for a price plan

data.pricePlanDetails.entitlementRateCards

object[]

data.pricePlanDetails.creditGrantRateCards

object[]

data.pricePlanDetails.creditGrantRateCards.id

string

required

data.pricePlanDetails.creditGrantRateCards.displayName

string

data.pricePlanDetails.creditGrantRateCards.tag

string

A tag string to group creditGrantRateCard

data.pricePlanDetails.creditGrantRateCards.grantDetails

object

required

Grant details of Credit Grant Rate Card

data.pricePlanDetails.creditGrantRateCards.rateDetails

object

required

Amount to be credited

data.pricePlanDetails.creditGrantRateCards.invoiceTiming

enum<string>

If IN_ADVANCE, the fixed fee will be invoiced in the previous billing cycle. If IN_ARREARS, the fixed fee will be invoiced in the current billing cycle.

Available options:

IN_ADVANCE,

IN_ARREARS

data.pricePlanDetails.creditGrantRateCards.type

enum<string>

Credit grant applies either for a one-time occurrence or for each cycle.

Available options:

ONE_TIME,

RECURRING

data.pricePlanDetails.creditGrantRateCards.recurrenceConfig

object

data.pricePlanDetails.type

enum<string>

Type of price plan

Available options:

ENTITLEMENT,

BILLING,

PURCHASE

data.startDate

string

required

data.endDate

string

required

data.version

integer

required

data.pricePlanId

string

required

nextToken

string

previousToken

string

Edit schedules of an account.Approve or decline a purchase of a billing plan

curl --request GET \
  --url https://api.togai.com/accounts/{account_id}/pricing_schedules \
  --header 'Authorization: <authorization>'

{
  "data": [
    {
      "pricePlanId": "pp.bs8932bf328"
    },
    {
      "startDate": "2080-10-04T00:00:00Z",
      "endDate": "2099-10-04T00:00:00Z",
      "pricePlanDetails": {
        "supportedCurrencies": [
          "USD"
        ],
        "activeCurrencies": [
          "USD"
        ],
        "pricingCycleConfig": {
          "interval": "MONTHLY",
          "startOffset": {
            "dayOffset": "4",
            "monthOffset": "NIL"
          },
          "gracePeriod": 3
        },
        "usageRateCards": [
          {
            "displayName": "Local Rides",
            "usageMeterId": "um.1zYnCiM9Bpg.1zYn",
            "ratePlan": {
              "pricingModel": "TIERED",
              "slabs": [
                {
                  "order": 1,
                  "startAfter": 0,
                  "priceType": "FLAT"
                }
              ]
            },
            "rateValues": [
              {
                "currency": "USD",
                "slabRates": [
                  {
                    "rate": 40,
                    "order": 1
                  }
                ]
              }
            ]
          }
        ],
        "fixedFeeRateCards": [
          {
            "id": "addon.2077efUBMXo.DyzlZ",
            "displayName": "Maintenance",
            "rateValues": [
              {
                "currency": "USD",
                "rate": 10
              }
            ]
          }
        ],
        "minimumCommitment": {
          "displayName": "Minimum Commitment",
          "rateValues": [
            {
              "currency": "USD",
              "rate": 10
            }
          ]
        }
      }
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
}

Introduction

APIs

List pricing schedules of an account

Authorizations

Path Parameters

Query Parameters

Response