Skip to navigation
Transaction APIPortal Urls

Create a portal url

Requires the PORTAL_URL.CREATE permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1
version

Headers

x-platform-idstringOptional
Platform ID.

Request

This endpoint expects an object.
typeenum or nullRequired
customer_idstring or nullOptional
Resource ID of type CUSTOMER
statusenum or nullOptional

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.

Allowed values:
expiry_periodobjectOptional

How long the link stays valid after it is created; sets expires_at. For type CHECKOUT_SESSION at least 30 MINUTE and at most 1 HOUR, 1 HOUR when omitted, and it can not be changed afterwards.

embeddedboolean or nullOptional
template_idstring or nullOptional
widgetsobject or nullOptional
invoiceobjectOptional
customerobjectOptional
quote_versionobjectOptional
init_pricing_plan_subscriptionobjectOptional
checkout_sessionobjectOptional

The checkout session. Required for type CHECKOUT_SESSION.

Response

Created
object_typestring or nullOptionalRead-only
idstring or nullOptionalRead-only
typeenum or nullOptional
customer_idstring or nullOptional
Resource ID of type CUSTOMER
statusenum or nullOptional

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.

Allowed values:
authenticationenum or nullOptionalRead-only

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

Allowed values:
created_atstring or nullOptionalRead-only
updated_atstring or nullOptionalRead-only
expiry_periodobjectOptional

How long the link stays valid after it is created; sets expires_at. For type CHECKOUT_SESSION at least 30 MINUTE and at most 1 HOUR, 1 HOUR when omitted, and it can not be changed afterwards.

expires_atstring or nullOptionalRead-only
embeddedboolean or nullOptional
template_idstring or nullOptional
tokenstring or nullOptionalRead-only
urlstring or nullOptionalRead-only
widgetsobject or nullOptional
invoiceobjectOptional
customerobjectOptional
quote_versionobjectOptional
init_pricing_plan_subscriptionobjectOptional
checkout_sessionobjectOptional

The checkout session. Required for type CHECKOUT_SESSION.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
500
Internal Server Error