GET
/
accounts
/
{account_id}
/
pricing_schedules
curl --request GET \
  --url https://api.togai.com/accounts/{account_id}/pricing_schedules \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "sch.4325kbjedsc.34dww",
      "pricePlanId": "pp.bs8932bf328",
      "version": 1,
      "startDate": "2080-10-04T00:00:00Z",
      "endDate": "2099-10-04T00:00:00Z",
      "isOverriden": false,
      "pricePlanDetails": {
        "supportedCurrencies": [
          "USD"
        ],
        "activeCurrencies": [
          "USD"
        ],
        "pricingCycleConfig": {
          "interval": "MONTHLY",
          "startOffset": {
            "dayOffset": "4",
            "monthOffset": "NIL"
          },
          "gracePeriod": 3,
          "anniversaryCycle": false
        },
        "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",
            "enableProration": false,
            "rateValues": [
              {
                "currency": "USD",
                "rate": 10
              }
            ]
          }
        ],
        "minimumCommitment": {
          "displayName": "Minimum Commitment",
          "rateValues": [
            {
              "currency": "USD",
              "rate": 10
            }
          ]
        }
      }
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==",
  "previousToken": "eyJwYXlsb2FkIjp7InN0YXJ0X2RhdGUiOiInsic3RhcnRfZGF0ZWxsfSwidG9rZW5UeXBlIjoiUifQ=="
}

Deprecated: This API is deprecated and will be removed in a future release. Please use the List pricing schedules of an account instead for updated functionality.

Authorizations

​
Authorization
string
header
required

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

Maximum length: 50
Example:

"ACC00001"

Query Parameters

​
nextToken
string
Example:

"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="

​
pageSize
number
Example:

10

​
start_date
string
Example:

"2023-03-30T10:41:10.088499"

​
end_date
string
Example:

"2099-03-30T10:41:10.088499"

​
include_price_plan_info
boolean
Example:

true

​
compact
boolean
Example:

false

Response

200
application/json
Response for list pricing schedules request
​
data
object[]

Represents effectiveness period and config of a price plan. i.e, price plan bound by time.

​
nextToken
string
​
previousToken
string