(DEPRECATED) List price plans - Togai documentation

Introduction

APIs

Authentication
Customers
Accounts
Aliases
Event Schemas
Usage Meters
AddOns
Licenses
Feature
(Deprecated) Price Plans
- GET
  (DEPRECATED) List price plans
- POST
  (DEPRECATED) Create a price plan
- GET
  (DEPRECATED) Get a price plan
- PATCH
  (DEPRECATED) Update a price plan
- POST
  (DEPRECATED) Activate a price plan
- POST
  (DEPRECATED) Create a price plan migration
- DEL
  (DEPRECATED) Archive a price plan
Price Plan V2
Settings
Price Experimentation
Jobs
Event Ingestion
Entitlements
Event Management
Metrics
Credits
Invoices
Payments
Wallet
InvoiceGroups
Alerts
Reports

GET

price_plans

curl --request GET \
  --url https://api.togai.com/price_plans \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "um.1zYnCiM9Bpg.lv25y",
      "version": 1,
      "type": "BILLING",
      "name": "Rides - Pro plan",
      "description": "",
      "status": "DRAFT",
      "usageMeters": [
        "um.1zlQTBWlkeO.lB7fh",
        "um.1zYnCiM9Bpg.1zYn"
      ],
      "pricePlanDetails": {
        "pricingCycleConfig": {
          "interval": "MONTHLY",
          "startOffset": {
            "dayOffset": "4",
            "monthOffset": "NIL"
          },
          "gracePeriod": 3,
          "anniversaryCycle": false
        },
        "supportedCurrencies": [
          "USD"
        ],
        "activeCurrencies": [
          "USD"
        ]
      },
      "updatedAt": "2020-01-01T00:00:00Z",
      "createdAt": "2020-01-01T00:00:00Z"
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
}

Deprecated: This API is deprecated and will be removed in a future release. Please use the List price plans V2 API instead for updated functionality.

Fields that can be searched on using _search query param

string

name

string

description

string

Fields with which the list response can be sorted using _sort query param

string

updated_at

string

Default sort order:updated_at DESC, id ASC

Authorizations

Authorization

string

header

required

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

Query Parameters

nextToken

string

Example:

"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="

pageSize

number

Example:

10

Response

200

application/json

Response for list price plans request

data

object[]

required

Data of price plan list

data.id

string

required

Identifier of price plan

Maximum length: 50

data.name

string

required

Name of the price plan

Maximum length: 50

data.version

integer

required

Version of the price plan

data.status

enum<string>

required

Status of Price plan

Available options:

DRAFT,

ACTIVE,

ARCHIVED

data.usageMeters

string[]

required

Usage meters id linked to the price plan

data.pricePlanDetails

object

required

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.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.

Example:

3

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.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: LAST, 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: LAST, monthOffset: 2}
28th Feb - {dayOffset: LAST, 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

Maximum length: 50

data.pricePlanDetails.licenseRateCards.enableProration

boolean

required

Example:

false

data.pricePlanDetails.licenseRateCards.ratePlan

object

required

Contains all rate related configurations

data.pricePlanDetails.licenseRateCards.rateValues

object[]

required

Represents a rate

data.pricePlanDetails.licenseRateCards.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.pricePlanDetails.licenseRateCards.displayName

string

Name of the attached AddOn

data.pricePlanDetails.licenseRateCards.name

string

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

data.pricePlanDetails.licenseRateCards.tag

string

A tag string to group licenseRateCards

data.pricePlanDetails.licenseRateCards.invoiceTiming

enum<string>

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.pricePlanDetails.licenseRateCards.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.pricePlanDetails.licenseRateCards.config

object

data.pricePlanDetails.licenseRateCards.proratedRefundMode

enum<string>

Available options:

NONE,

CREDITS,

PAYMENT,

WALLET

data.pricePlanDetails.billingEntitlementRateCards

object[]

Billing Entitlement rate card

data.pricePlanDetails.billingEntitlementRateCards.featureId

string

required

data.pricePlanDetails.billingEntitlementRateCards.featureConfigs

object[]

required

Feature configuration object

data.pricePlanDetails.billingEntitlementRateCards.invoiceTiming

enum<string>

required

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

data.pricePlanDetails.billingEntitlementRateCards.ratePlan

object

required

Contains all rate related configurations

data.pricePlanDetails.billingEntitlementRateCards.rateValues

object[]

required

Represents a rate

data.pricePlanDetails.billingEntitlementRateCards.tag

string

A tag string to group rate cards

data.pricePlanDetails.billingEntitlementRateCards.displayName

string

Name your rate card, this will be used in invoice

data.pricePlanDetails.billingEntitlementRateCards.name

string

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

data.pricePlanDetails.billingEntitlementRateCards.recurrenceConfig

object

data.pricePlanDetails.entitlementOverageRateCards

object[]

data.pricePlanDetails.entitlementOverageRateCards.featureId

string

required

Unique Identifier of the attached Feature

Maximum length: 50

data.pricePlanDetails.entitlementOverageRateCards.ratePlan

object

required

Contains all rate related configurations

data.pricePlanDetails.entitlementOverageRateCards.rateValues

object[]

required

Represents a rate

data.pricePlanDetails.entitlementOverageRateCards.displayName

string

Name to be displayed during invoice

data.pricePlanDetails.entitlementOverageRateCards.name

string

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

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.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.creditGrantRateCards

object[]

Credit grant rate card

data.pricePlanDetails.creditGrantRateCards.id

string

required

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.displayName

string

data.pricePlanDetails.creditGrantRateCards.name

string

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

data.pricePlanDetails.creditGrantRateCards.tag

string

A tag string to group creditGrantRateCard

data.pricePlanDetails.creditGrantRateCards.invoiceTiming

enum<string>

Available options:

IN_ADVANCE,

IN_ARREARS,

PREPAID

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:

BILLING,

PURCHASE

data.pricePlanDetails.deferredRevenue

boolean

data.pricePlanDetails.allow_ongoing_cycle_updates

any

Allow changes to price plan from the beginning of the ongoing cycle. type: boolean

data.createdAt

string

required

data.updatedAt

string

required

data.type

enum<string>

required

Type of price plan

Available options:

BILLING,

PURCHASE

data.description

string

Description of price plan

Maximum length: 255

data.pricingRules

object[]

Represents pricing rules of a price plan. i.e, price plan bound by time.

nextToken

string

context

object

Update a Feature (DEPRECATED) Create a price plan

curl --request GET \
  --url https://api.togai.com/price_plans \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "um.1zYnCiM9Bpg.lv25y",
      "version": 1,
      "type": "BILLING",
      "name": "Rides - Pro plan",
      "description": "",
      "status": "DRAFT",
      "usageMeters": [
        "um.1zlQTBWlkeO.lB7fh",
        "um.1zYnCiM9Bpg.1zYn"
      ],
      "pricePlanDetails": {
        "pricingCycleConfig": {
          "interval": "MONTHLY",
          "startOffset": {
            "dayOffset": "4",
            "monthOffset": "NIL"
          },
          "gracePeriod": 3,
          "anniversaryCycle": false
        },
        "supportedCurrencies": [
          "USD"
        ],
        "activeCurrencies": [
          "USD"
        ]
      },
      "updatedAt": "2020-01-01T00:00:00Z",
      "createdAt": "2020-01-01T00:00:00Z"
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
}