Get a list of portal urls | Solvimon

curl https://api.solvimon.com/v1/portal-urls \
     -H "X-API-KEY: <apiKey>"

{
  "data": [
    {
      "object_type": "string",
      "id": "string",
      "type": "INVOICE",
      "customer_id": "string",
      "status": "PUBLISHED",
      "created_at": "string",
      "updated_at": "string",
      "expiry_period": {
        "type": "DAY",
        "value": 1
      },
      "expires_at": "string",
      "embedded": true,
      "template_id": "string",
      "token": "string",
      "url": "string",
      "widgets": {
        "usage": "string",
        "invoices": "string",
        "pricing_plan_subscriptions": "string"
      },
      "invoice": {
        "id": "string",
        "options": {
          "download_invoice": true,
          "pay_open_invoice": true
        }
      },
      "customer": {
        "display": {
          "usage": true,
          "invoices": true,
          "pricing_plan_subscriptions": true,
          "payment_acceptors": true
        },
        "options": {
          "edit_customer_details": true,
          "download_invoice": true,
          "pay_open_invoice": true,
          "combine_open_invoices": true
        }
      },
      "quote_version": {
        "id": "string"
      },
      "init_pricing_plan_subscription": {
        "pricing_plan_subscription_id": "string",
        "success_url": "string"
      }
    }
  ],
  "page": 1,
  "limit": 1,
  "links": {
    "first": "string",
    "previous": "string",
    "current": "string",
    "next": "string"
  },
  "total_number_of_pages": 1
}

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1

version

Query parameters

customer_idstringOptional

Filter based of customer ID

pricing_plan_subscription_idstringOptional

Filter based of pricing plan subscription ID

typestringOptional

Filter portal urls based on the type

statusstringOptional

Filter portal urls based on the status

expiredstringOptional

Filter portal urls based on whether it is expired (true or false)

limitintegerOptional

The amount of records shown in the list

pageintegerOptional

The page which is going to be shown

Response

datalist of objects

pageinteger or null

limitinteger or null

linksobject

total_number_of_pagesinteger or nullDeprecated

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors