List rate cards

GET

schedules

{schedule_id}

rate_cards

curl --request GET \
  --url https://api.togai.com/v2/schedules/{schedule_id}/rate_cards \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "billableId": "<string>",
      "type": "MINIMUM_COMMITMENT",
      "displayName": "<string>",
      "invoiceTiming": "IN_ADVANCE",
      "rateCardDetails": {
        "fixedFeeRateCard": {
          "id": "<string>",
          "displayName": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "invoiceTiming": "IN_ADVANCE",
          "type": "ONE_TIME",
          "rateValues": [
            {
              "currency": "<string>",
              "rate": 123
            }
          ],
          "enableProration": false,
          "recurrenceConfig": {
            "interval": 3,
            "offset": 5
          }
        },
        "billingEntitlementRateCard": {
          "featureId": "<string>",
          "featureConfigs": [
            {
              "effectiveFrom": "<string>",
              "effectiveUntil": "<string>",
              "featureCreditLimit": 1
            }
          ],
          "tag": "<string>",
          "invoiceTiming": "IN_ADVANCE",
          "displayName": "<string>",
          "name": "<string>",
          "ratePlan": {
            "pricingModel": "TIERED",
            "slabs": [
              {
                "order": 5,
                "startAfter": 123,
                "priceType": "FLAT",
                "slabConfig": {}
              }
            ]
          },
          "rateValues": [
            {
              "currency": "<string>",
              "slabRates": [
                {
                  "order": 123,
                  "rate": 123,
                  "slabRateConfig": {}
                }
              ],
              "rateConfig": {}
            }
          ],
          "recurrenceConfig": {
            "interval": 3,
            "offset": 5
          }
        },
        "creditGrantRateCard": {
          "id": "<string>",
          "displayName": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "grantDetails": {
            "priority": 1,
            "expiryType": "PRICING_CYCLE",
            "expiryDuration": "<string>",
            "applicableEntityIds": [
              "<string>"
            ]
          },
          "rateDetails": {
            "pricingModel": "TIERED",
            "currencySlabRateDetails": [
              {
                "currency": "<string>",
                "creditAmount": 1,
                "slabDetails": [
                  {
                    "startAfter": 123,
                    "priceType": "FLAT",
                    "slabConfig": {},
                    "rate": 123,
                    "slabRateConfig": {}
                  }
                ],
                "rateConfig": {}
              }
            ]
          },
          "invoiceTiming": "IN_ADVANCE",
          "type": "ONE_TIME",
          "recurrenceConfig": {
            "interval": 3,
            "offset": 5
          }
        },
        "usageRateCard": {
          "displayName": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "usageMeterId": "um.1zYnCiM9Bpg.1zYn",
          "ratePlan": {
            "pricingModel": "TIERED",
            "slabs": [
              {
                "order": 5,
                "startAfter": 123,
                "priceType": "FLAT",
                "slabConfig": {}
              }
            ]
          },
          "rateValues": [
            {
              "currency": "<string>",
              "slabRates": [
                {
                  "order": 123,
                  "rate": 123,
                  "slabRateConfig": {}
                }
              ],
              "rateConfig": {}
            }
          ]
        },
        "licenseRateCard": {
          "id": "<string>",
          "type": "LICENSE",
          "displayName": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "invoiceTiming": "IN_ADVANCE",
          "usageCycle": "WEEKLY",
          "enableProration": false,
          "config": {
            "maxQuantity": 100,
            "maxQuantityBreachAction": "DO_NOTHING"
          },
          "ratePlan": {
            "pricingModel": "TIERED",
            "slabs": [
              {
                "order": 5,
                "startAfter": 123,
                "priceType": "FLAT",
                "slabConfig": {}
              }
            ]
          },
          "rateValues": [
            {
              "currency": "<string>",
              "slabRates": [
                {
                  "order": 123,
                  "rate": 123,
                  "slabRateConfig": {}
                }
              ],
              "rateConfig": {}
            }
          ],
          "proratedRefundMode": "NONE"
        },
        "entitlementOverageRateCard": {
          "featureId": "<string>",
          "displayName": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "maxQuantity": 123,
          "ratePlan": {
            "pricingModel": "TIERED",
            "slabs": [
              {
                "order": 5,
                "startAfter": 123,
                "priceType": "FLAT",
                "slabConfig": {}
              }
            ]
          },
          "rateValues": [
            {
              "currency": "<string>",
              "slabRates": [
                {
                  "order": 123,
                  "rate": 123,
                  "slabRateConfig": {}
                }
              ],
              "rateConfig": {}
            }
          ],
          "billingConfig": {
            "interval": 3,
            "startOffset": 5
          }
        },
        "minimumCommitmentRateCard": {
          "displayName": "<string>",
          "rateValues": [
            {
              "currency": "<string>",
              "rate": 123
            }
          ]
        }
      },
      "tag": "<string>",
      "name": "<string>",
      "referenceId": "<string>",
      "referenceType": "<string>",
      "currencies": [
        "<string>"
      ],
      "pricePlanId": "<string>",
      "accountId": "<string>"
    }
  ],
  "nextToken": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

schedule_id

string

required

Query Parameters

nextToken

string

pageSize

number

mode

string

required

Possible values:

ACTIVE - Get the active rate card
DRAFT - Get the draft rate card

Response

200

application/json

Response for list rate cards request

Paginated response for rate card

data

object[]

required

data.billableId

string

required

Billable identifier

Maximum length: 50

data.type

enum<string>

required

Rate card type

Available options:

MINIMUM_COMMITMENT,

BILLING_ENTITLEMENT,

CREDIT_GRANT,

ENTITLEMENT_OVERAGE,

FIXED_FEE,

LICENSE,

USAGE

data.displayName

string

required

Display name of the rate card

Maximum length: 255

data.invoiceTiming

enum<string>

required

If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle. If IN_ARREARS, the rate card will be invoiced in the current billing cycle. If PREPAID, credits/entitlements will be granted only after invoice is paid

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

data.rateCardDetails

object

required

Rate card details

data.rateCardDetails.fixedFeeRateCard

object

data.rateCardDetails.billingEntitlementRateCard

object

Billing Entitlement rate card

data.rateCardDetails.billingEntitlementRateCard.featureId

string

required

data.rateCardDetails.billingEntitlementRateCard.featureConfigs

object[]

required

data.rateCardDetails.billingEntitlementRateCard.invoiceTiming

enum<string>

required

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

data.rateCardDetails.billingEntitlementRateCard.ratePlan

object

required

Contains all rate related configurations

data.rateCardDetails.billingEntitlementRateCard.rateValues

object[]

required

data.rateCardDetails.billingEntitlementRateCard.tag

string

A tag string to group rate cards

data.rateCardDetails.billingEntitlementRateCard.displayName

string

Name your rate card, this will be used in invoice

data.rateCardDetails.billingEntitlementRateCard.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

data.rateCardDetails.billingEntitlementRateCard.recurrenceConfig

object

data.rateCardDetails.creditGrantRateCard

object

Credit grant rate card

data.rateCardDetails.creditGrantRateCard.id

string

required

data.rateCardDetails.creditGrantRateCard.grantDetails

object

required

Grant details of Credit Grant Rate Card

data.rateCardDetails.creditGrantRateCard.rateDetails

object

required

Amount to be credited

data.rateCardDetails.creditGrantRateCard.displayName

string

data.rateCardDetails.creditGrantRateCard.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

data.rateCardDetails.creditGrantRateCard.tag

string

A tag string to group creditGrantRateCard

data.rateCardDetails.creditGrantRateCard.invoiceTiming

enum<string>

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

data.rateCardDetails.creditGrantRateCard.type

enum<string>

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

Available options:

ONE_TIME,

RECURRING

data.rateCardDetails.creditGrantRateCard.recurrenceConfig

object

data.rateCardDetails.usageRateCard

object

data.rateCardDetails.licenseRateCard

object

data.rateCardDetails.licenseRateCard.id

string

required

Unique Identifier of the attached AddOn

Maximum length: 50

data.rateCardDetails.licenseRateCard.enableProration

boolean

required

data.rateCardDetails.licenseRateCard.ratePlan

object

required

Contains all rate related configurations

data.rateCardDetails.licenseRateCard.rateValues

object[]

required

data.rateCardDetails.licenseRateCard.type

enum<string>

LICENSE: Addon can be used in license rate cards FIXED_FEE: Addon can be used in fixed fee rate cards CREDIT_GRANT: Addon can be used in credit grant rate cards NAMED_LICENSE: Addon can be used in license rate cards

Available options:

LICENSE,

FIXED_FEE,

CREDIT_GRANT,

NAMED_LICENSE

data.rateCardDetails.licenseRateCard.displayName

string

Name of the attached AddOn

data.rateCardDetails.licenseRateCard.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

data.rateCardDetails.licenseRateCard.tag

string

A tag string to group licenseRateCards

data.rateCardDetails.licenseRateCard.invoiceTiming

enum<string>

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

data.rateCardDetails.licenseRateCard.usageCycle

enum<string>

UsageCycleInterval field allows you to treat the billing interval as many smaller windows. Revenue is calculated for each of the windows (usage cycles) and their sum is considered as the billing interval revenue. Example: 1 Named License being used across entire billing interval. Rate Value: $1/license CASE 1: Without usage cycle. $1 is charged for the entire billing cycle. CASE 2: Usage cycle is configure to be WEEKLY and the billing interval has 4 weeks. In this case $1 is charged for each week totalling to $4 across for the billing interval

Available options:

WEEKLY,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

ANNUALLY

data.rateCardDetails.licenseRateCard.config

object

data.rateCardDetails.licenseRateCard.proratedRefundMode

enum<string>

Available options:

NONE,

CREDITS,

PAYMENT,

WALLET

data.rateCardDetails.entitlementOverageRateCard

object

data.rateCardDetails.entitlementOverageRateCard.featureId

string

required

Unique Identifier of the attached Feature

Maximum length: 50

data.rateCardDetails.entitlementOverageRateCard.ratePlan

object

required

Contains all rate related configurations

data.rateCardDetails.entitlementOverageRateCard.rateValues

object[]

required

data.rateCardDetails.entitlementOverageRateCard.displayName

string

Name to be displayed during invoice

data.rateCardDetails.entitlementOverageRateCard.name

string

Unique identifier for the rate card in a price plan. If left null it is auto-generated.

data.rateCardDetails.entitlementOverageRateCard.tag

string

A tag string to group rate cards

data.rateCardDetails.entitlementOverageRateCard.maxQuantity

number

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

data.rateCardDetails.entitlementOverageRateCard.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.rateCardDetails.minimumCommitmentRateCard

object

data.name

string

required

Maximum length: 50

data.referenceId

string

required

Maximum length: 50

data.referenceType

string

required

Maximum length: 50

data.pricePlanId

string

required

Price plan identifier

Maximum length: 50

data.tag

string

Tag for rate card

Maximum length: 50

data.currencies

string[]

List of currencies supported by the rate card

data.accountId

string

Account identifier

nextToken

string

(DEPRECATED) Approve or decline a purchase of a billing plan Bulk rate card operations on a schedule

curl --request GET \
  --url https://api.togai.com/v2/schedules/{schedule_id}/rate_cards \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "billableId": "<string>",
      "type": "MINIMUM_COMMITMENT",
      "displayName": "<string>",
      "invoiceTiming": "IN_ADVANCE",
      "rateCardDetails": {
        "fixedFeeRateCard": {
          "id": "<string>",
          "displayName": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "invoiceTiming": "IN_ADVANCE",
          "type": "ONE_TIME",
          "rateValues": [
            {
              "currency": "<string>",
              "rate": 123
            }
          ],
          "enableProration": false,
          "recurrenceConfig": {
            "interval": 3,
            "offset": 5
          }
        },
        "billingEntitlementRateCard": {
          "featureId": "<string>",
          "featureConfigs": [
            {
              "effectiveFrom": "<string>",
              "effectiveUntil": "<string>",
              "featureCreditLimit": 1
            }
          ],
          "tag": "<string>",
          "invoiceTiming": "IN_ADVANCE",
          "displayName": "<string>",
          "name": "<string>",
          "ratePlan": {
            "pricingModel": "TIERED",
            "slabs": [
              {
                "order": 5,
                "startAfter": 123,
                "priceType": "FLAT",
                "slabConfig": {}
              }
            ]
          },
          "rateValues": [
            {
              "currency": "<string>",
              "slabRates": [
                {
                  "order": 123,
                  "rate": 123,
                  "slabRateConfig": {}
                }
              ],
              "rateConfig": {}
            }
          ],
          "recurrenceConfig": {
            "interval": 3,
            "offset": 5
          }
        },
        "creditGrantRateCard": {
          "id": "<string>",
          "displayName": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "grantDetails": {
            "priority": 1,
            "expiryType": "PRICING_CYCLE",
            "expiryDuration": "<string>",
            "applicableEntityIds": [
              "<string>"
            ]
          },
          "rateDetails": {
            "pricingModel": "TIERED",
            "currencySlabRateDetails": [
              {
                "currency": "<string>",
                "creditAmount": 1,
                "slabDetails": [
                  {
                    "startAfter": 123,
                    "priceType": "FLAT",
                    "slabConfig": {},
                    "rate": 123,
                    "slabRateConfig": {}
                  }
                ],
                "rateConfig": {}
              }
            ]
          },
          "invoiceTiming": "IN_ADVANCE",
          "type": "ONE_TIME",
          "recurrenceConfig": {
            "interval": 3,
            "offset": 5
          }
        },
        "usageRateCard": {
          "displayName": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "usageMeterId": "um.1zYnCiM9Bpg.1zYn",
          "ratePlan": {
            "pricingModel": "TIERED",
            "slabs": [
              {
                "order": 5,
                "startAfter": 123,
                "priceType": "FLAT",
                "slabConfig": {}
              }
            ]
          },
          "rateValues": [
            {
              "currency": "<string>",
              "slabRates": [
                {
                  "order": 123,
                  "rate": 123,
                  "slabRateConfig": {}
                }
              ],
              "rateConfig": {}
            }
          ]
        },
        "licenseRateCard": {
          "id": "<string>",
          "type": "LICENSE",
          "displayName": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "invoiceTiming": "IN_ADVANCE",
          "usageCycle": "WEEKLY",
          "enableProration": false,
          "config": {
            "maxQuantity": 100,
            "maxQuantityBreachAction": "DO_NOTHING"
          },
          "ratePlan": {
            "pricingModel": "TIERED",
            "slabs": [
              {
                "order": 5,
                "startAfter": 123,
                "priceType": "FLAT",
                "slabConfig": {}
              }
            ]
          },
          "rateValues": [
            {
              "currency": "<string>",
              "slabRates": [
                {
                  "order": 123,
                  "rate": 123,
                  "slabRateConfig": {}
                }
              ],
              "rateConfig": {}
            }
          ],
          "proratedRefundMode": "NONE"
        },
        "entitlementOverageRateCard": {
          "featureId": "<string>",
          "displayName": "<string>",
          "name": "<string>",
          "tag": "<string>",
          "maxQuantity": 123,
          "ratePlan": {
            "pricingModel": "TIERED",
            "slabs": [
              {
                "order": 5,
                "startAfter": 123,
                "priceType": "FLAT",
                "slabConfig": {}
              }
            ]
          },
          "rateValues": [
            {
              "currency": "<string>",
              "slabRates": [
                {
                  "order": 123,
                  "rate": 123,
                  "slabRateConfig": {}
                }
              ],
              "rateConfig": {}
            }
          ],
          "billingConfig": {
            "interval": 3,
            "startOffset": 5
          }
        },
        "minimumCommitmentRateCard": {
          "displayName": "<string>",
          "rateValues": [
            {
              "currency": "<string>",
              "rate": 123
            }
          ]
        }
      },
      "tag": "<string>",
      "name": "<string>",
      "referenceId": "<string>",
      "referenceType": "<string>",
      "currencies": [
        "<string>"
      ],
      "pricePlanId": "<string>",
      "accountId": "<string>"
    }
  ],
  "nextToken": "<string>"
}

Introduction

APIs

Authorizations

Path Parameters

Query Parameters

Response