Skip to main content
POST
/
instances
/
{id}
/
subscribe
Subscribe instance
curl --request POST \
  --url https://api.vzaps.com/instances/{id}/subscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "url": "",
  "session_id": "sub_xxxxxxxx",
  "mode": "direct",
  "subscription_id": "sub_xxxxxxxx"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Identificador publico da instancia no formato gerado pela plataforma: prefixo VZ seguido de caracteres alfanumericos.

Example:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

Body

application/json
​
successUrl
string
​
cancelUrl
string
​
returnUrl
string
​
preferCheckout
boolean
default:false

Response

Session created

​
url
string
​
session_id
string
​
mode
enum<string>
Available options:
checkout,
direct
​
subscription_id
string