Skip to main content
POST
Subscribe to product plan

Authorizations

token
string
query
required

Vida API Token

Body

application/json
productPlanId
string
required

Product Plan Id to enable subscription

Example:

"pplan-vida-business-basic"

term
string
required

Subscription length of month or year

Example:

"month"

cancelUrl
string

If using external payment processor (eg Stripe) what url to redirect if payment canceled

Example:

"https://yoursite.io/cancel"

successUrl
string

If using external payment processor (eg Stripe) what url to redirect if payment successful

Example:

"https://yoursite.io/success"

checkoutType
string

Which checkout session you would like to start. Embedded session or external redirect url

Example:

"embedded"

Response

Successfully subscribed

success
boolean
Example:

true

message
string
Example:

"Success"