portalUrls

Create a portal url

Requires the PORTAL_URL.CREATE permission.

post/v{version}/portal-urls

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/portal-urls
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Headers

x-platform-idstring

Platform ID.

Request body

object_typestring nullable
idstring nullable
type'INVOICE' | 'PAY_INVOICE' | 'CUSTOMER' | 'QUOTE_VERSION' | 'INIT_PRICING_PLAN_SUBSCRIPTION' | 'CHECKOUT_SESSION' required
customer_idstring nullable

Resource ID of type CUSTOMER

status'PUBLISHED' | 'REVOKED' | 'EXPIRED' | 'CLOSED'

The status of the link. PUBLISHED: the link can be used until expires_at. REVOKED: the platform revoked the link. EXPIRED: expires_at passed while the link was PUBLISHED. CLOSED: the checkout session of the link is done (COMPLETED or FAILED); the link accepts no more changes and does not expire.

authentication'IDENTITY_TOKEN' | 'SIGNED_TOKEN'

How the link authenticates the customer, derived from the type. A SIGNED_TOKEN link returns its token and url only when it is created.

created_atstring nullable
updated_atstring nullable
expires_atstring nullable
embeddedboolean nullable
template_idstring nullable
tokenstring nullable
urlstring nullable

Response

Created

object_typestring nullable
idstring nullable
type'INVOICE' | 'PAY_INVOICE' | 'CUSTOMER' | 'QUOTE_VERSION' | 'INIT_PRICING_PLAN_SUBSCRIPTION' | 'CHECKOUT_SESSION'
customer_idstring nullable

Resource ID of type CUSTOMER

status'PUBLISHED' | 'REVOKED' | 'EXPIRED' | 'CLOSED'

The status of the link. PUBLISHED: the link can be used until expires_at. REVOKED: the platform revoked the link. EXPIRED: expires_at passed while the link was PUBLISHED. CLOSED: the checkout session of the link is done (COMPLETED or FAILED); the link accepts no more changes and does not expire.

authentication'IDENTITY_TOKEN' | 'SIGNED_TOKEN'

How the link authenticates the customer, derived from the type. A SIGNED_TOKEN link returns its token and url only when it is created.

created_atstring nullable
updated_atstring nullable
expires_atstring nullable
embeddedboolean nullable
template_idstring nullable
tokenstring nullable
urlstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.