List Plans

GET

plans

curl --request GET \
  --url https://connect.withvayu.com/plans \
  --header 'Authorization: Bearer <token>'

{
  "plans": [
    {
      "name": "<string>",
      "status": "Active",
      "billingData": {
        "billingInterval": "Monthly",
        "duration": 1,
        "paymentTerm": "Postpayment",
        "autoRenewal": false,
        "proRated": true
      },
      "description": "<string>",
      "products": [
        {
          "name": "<string>",
          "description": "<string>",
          "variants": [
            {
              "meterId": "<string>",
              "pricing": {
                "pricingModel": "PerUnit",
                "priceConfiguration": {
                  "price": 1,
                  "chunkSize": 1
                }
              },
              "settings": {
                "productType": "Credit",
                "productConfiguration": {
                  "shouldCreateSeparateInvoice": false
                }
              },
              "description": "<string>",
              "name": "<string>"
            }
          ],
          "basePrice": 1,
          "commitment": {
            "amount": 1,
            "type": "Price",
            "replenishmentInterval": 123
          },
          "currencyCommitment": 123,
          "paymentTerm": "Postpayment",
          "billingInterval": "Monthly",
          "accumulationInterval": 123,
          "proRata": true,
          "erpMetadata": {
            "erpId": "<string>",
            "erpName": "<string>",
            "displayId": "<string>"
          },
          "rateMultiplier": 123,
          "isPeriodicVariants": false
        }
      ],
      "trial": {
        "duration": 123,
        "type": "Weeks",
        "free": false
      },
      "basedFromPlanId": "<string>",
      "purchaseOrder": "<string>",
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "hasMore": true,
  "nextCursor": "<string>"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

limit

number

default:10

Required range: x <= 1000

cursor

string

Response

200

application/json

RequestSuccess

plans

object[]

required

plans.id

string

required

plans.createdAt

string

required

plans.updatedAt

string

required

plans.name

string

The name of the plan

Minimum length: 1

plans.status

enum<string>

The status of the plan. plan statuses are active, inactive

Available options:

Active,

Inactive,

Error

plans.billingData

object

The billing data of the plan. The billing data contains the billing interval, the plan duration the payment terms and auto renewal, and the billing method.

plans.description

The description of the plan

Minimum length: 1

plans.products

object[]

The products of the plan

plans.products.variants

object[]

required

plans.products.paymentTerm

enum<string>

default:Postpayment

required

flag to indicate if the payment is postpayment or prepayment

Available options:

Prepayment,

Postpayment

plans.products.billingInterval

enum<string>

required

Available options:

Monthly,

BiMonthly,

Quarterly,

SixMonths,

Yearly

plans.products.name

string

Minimum length: 1

plans.products.description

string

plans.products.basePrice

number

Required range: x >= 0

plans.products.commitment

object

plans.products.currencyCommitment

number

plans.products.accumulationInterval

number

plans.products.proRata

boolean

plans.products.erpMetadata

object

plans.products.rateMultiplier

number

plans.products.isPeriodicVariants

boolean

default:false

plans.trial

The trial duration of the plan

plans.basedFromPlanId

The plan ID that this plan is based on

plans.purchaseOrder

string

The purchase order number

Maximum length: 20

total

number

required

hasMore

boolean

required

nextCursor

string

Delete Plan Create Plan

curl --request GET \
  --url https://connect.withvayu.com/plans \
  --header 'Authorization: Bearer <token>'

{
  "plans": [
    {
      "name": "<string>",
      "status": "Active",
      "billingData": {
        "billingInterval": "Monthly",
        "duration": 1,
        "paymentTerm": "Postpayment",
        "autoRenewal": false,
        "proRated": true
      },
      "description": "<string>",
      "products": [
        {
          "name": "<string>",
          "description": "<string>",
          "variants": [
            {
              "meterId": "<string>",
              "pricing": {
                "pricingModel": "PerUnit",
                "priceConfiguration": {
                  "price": 1,
                  "chunkSize": 1
                }
              },
              "settings": {
                "productType": "Credit",
                "productConfiguration": {
                  "shouldCreateSeparateInvoice": false
                }
              },
              "description": "<string>",
              "name": "<string>"
            }
          ],
          "basePrice": 1,
          "commitment": {
            "amount": 1,
            "type": "Price",
            "replenishmentInterval": 123
          },
          "currencyCommitment": 123,
          "paymentTerm": "Postpayment",
          "billingInterval": "Monthly",
          "accumulationInterval": 123,
          "proRata": true,
          "erpMetadata": {
            "erpId": "<string>",
            "erpName": "<string>",
            "displayId": "<string>"
          },
          "rateMultiplier": 123,
          "isPeriodicVariants": false
        }
      ],
      "trial": {
        "duration": 123,
        "type": "Weeks",
        "free": false
      },
      "basedFromPlanId": "<string>",
      "purchaseOrder": "<string>",
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "hasMore": true,
  "nextCursor": "<string>"
}

API Documentation

API Reference

Authorizations

Query Parameters

Response