Get a portal url by resource ID | Solvimon

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

{
  "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"
  }
}

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

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Response

object_typestring or nullRead-only

idstring or nullRead-only

typeenum or null

Allowed values:

customer_idstring or null

Resource ID of type CUSTOMER

statusenum or null

Allowed values:

created_atstring or nullRead-only

updated_atstring or nullRead-only

expiry_periodobject

expires_atstring or nullRead-only

embeddedboolean or null

template_idstring or null

tokenstring or nullRead-only

urlstring or nullRead-only

widgetsobject or null

invoiceobject

customerobject

quote_versionobject

init_pricing_plan_subscriptionobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors