Skip to content

Publish a widget — gated on a Stripe card-on-file

POST
/v1/widgets/{id}/publish

Authorizations

Parameters

Path Parameters

id
required
string format: uuid

Responses

200

Widget published

object
id
required
string format: uuid
published
required
boolean

401

Unauthorized

object
ok
required
boolean
error
required
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
requestId
string
>= 1 characters

402

Payment method required — redirect to checkoutUrl

object
ok
required
boolean
error
required
object
code
required
string
Allowed values: card_required
message
required
string
checkoutUrl
required
string format: uri
requestId
required
string

404

Widget not found or not owned by the caller

object
ok
required
boolean
error
required
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
requestId
string
>= 1 characters

500

Server error

object
ok
required
boolean
error
required
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
requestId
string
>= 1 characters