Skip to content
Docs

List Billing Plans For Product

Required
GET/v1/products/{productSlug}/plans
Edgenivo sends a request to the partner to return quotes for different billing plans for a specific Product.
Note: You can have this request triggered by Edgenivo before the integration is installed when the Product is created for the first time. In this case, OIDC will be incomplete and will not contain an account ID.
Edgenivo calls this endpoint to display available plans when a customer creates a resource. Edgenivo may call it before any installation exists, so the OIDC token may not include an account ID. Return the list of plans with their pricing, features, and any usage limits.
/v1/products/{productSlug}/plans
const response = await fetch('/v1/products/productSlug/plans?metadata=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});


const data = await response.json();
console.log(data);
Response
{
  "plans": [
    {
      "id": "icfg_1234567890",
      "type": "prepayment",
      "name": "Example Name",
      "scope": "installation",
      "description": "string",
      "paymentMethodRequired": "true",
      "preauthorizationAmount": "123",
      "initialCharge": "string",
      "minimumAmount": "100.00",
      "maximumAmount": "100.00",
      "maximumAmountAutoPurchasePerPeriod": "100.00",
      "cost": "string",
      "details": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "highlightedDetails": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "quote": [
        {
          "line": "string",
          "amount": "100.00"
        }
      ],
      "effectiveDate": "2024-01-01T00:00:00Z",
      "disabled": "true"
    }
  ]
}
Errors
{
  "error": {
    "code": "validation_error",
    "message": "string",
    "user": {
      "message": "string",
      "url": "https://example.com"
    },
    "fields": [
      {
        "key": "string",
        "message": "string"
      }
    ]
  }
}

Authentication

AuthorizationSystem Authentication

Default authentication mechanism

Path parameters

productSlugstringRequired

Query parameters

metadatastringOptional

Header parameters

X-Edgenivo-AuthstringOptional
The auth style used in the request (system, user, etc)

Response

200Return a list of billing plans
plansarrayRequired

Errors

400Input has failed validation
errorobjectRequired
403Operation failed because the authentication is not allowed to perform this operation
errorobjectRequired
409Operation failed because of a conflict with the current state of the resource
errorobjectRequired