curl --request POST \
--url https://api.uvvipay.com.br/v1/subscriptions/plan \
--header 'Content-Type: application/json' \
--header 'client-id: <api-key>' \
--header 'client-secret: <api-key>' \
--data '
{
"name": "Plano Mensal Pro",
"amount": 9900,
"currency": "BRL",
"allowed_payment_types": [
"credit_card"
],
"prevent_trial_abuse": true,
"description": "Acesso completo mensal",
"custom_interval": null,
"default_trial_duration": 16
}
'import requests
url = "https://api.uvvipay.com.br/v1/subscriptions/plan"
payload = {
"name": "Plano Mensal Pro",
"amount": 9900,
"currency": "BRL",
"allowed_payment_types": ["credit_card"],
"prevent_trial_abuse": True,
"description": "Acesso completo mensal",
"custom_interval": None,
"default_trial_duration": 16
}
headers = {
"client-id": "<api-key>",
"client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'client-id': '<api-key>',
'client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Plano Mensal Pro',
amount: 9900,
currency: 'BRL',
allowed_payment_types: ['credit_card'],
prevent_trial_abuse: true,
description: 'Acesso completo mensal',
custom_interval: null,
default_trial_duration: 16
})
};
fetch('https://api.uvvipay.com.br/v1/subscriptions/plan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.uvvipay.com.br/v1/subscriptions/plan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Plano Mensal Pro',
'amount' => 9900,
'currency' => 'BRL',
'allowed_payment_types' => [
'credit_card'
],
'prevent_trial_abuse' => true,
'description' => 'Acesso completo mensal',
'custom_interval' => null,
'default_trial_duration' => 16
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"client-id: <api-key>",
"client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.uvvipay.com.br/v1/subscriptions/plan"
payload := strings.NewReader("{\n \"name\": \"Plano Mensal Pro\",\n \"amount\": 9900,\n \"currency\": \"BRL\",\n \"allowed_payment_types\": [\n \"credit_card\"\n ],\n \"prevent_trial_abuse\": true,\n \"description\": \"Acesso completo mensal\",\n \"custom_interval\": null,\n \"default_trial_duration\": 16\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("client-id", "<api-key>")
req.Header.Add("client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.uvvipay.com.br/v1/subscriptions/plan")
.header("client-id", "<api-key>")
.header("client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Plano Mensal Pro\",\n \"amount\": 9900,\n \"currency\": \"BRL\",\n \"allowed_payment_types\": [\n \"credit_card\"\n ],\n \"prevent_trial_abuse\": true,\n \"description\": \"Acesso completo mensal\",\n \"custom_interval\": null,\n \"default_trial_duration\": 16\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uvvipay.com.br/v1/subscriptions/plan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["client-id"] = '<api-key>'
request["client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Plano Mensal Pro\",\n \"amount\": 9900,\n \"currency\": \"BRL\",\n \"allowed_payment_types\": [\n \"credit_card\"\n ],\n \"prevent_trial_abuse\": true,\n \"description\": \"Acesso completo mensal\",\n \"custom_interval\": null,\n \"default_trial_duration\": 16\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"amount": 123,
"pricing_type": "FIXED_PRICE",
"currency": "<string>",
"interval": "ONE_TIME",
"custom_interval": 123,
"allowed_payment_types": [
"credit_card"
],
"default_trial_unit": "DAY",
"default_trial_duration": 123,
"prevent_trial_abuse": true,
"plan_status": "ACTIVE",
"origin": "API",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Criar plano
Cria um novo plano de assinatura.
curl --request POST \
--url https://api.uvvipay.com.br/v1/subscriptions/plan \
--header 'Content-Type: application/json' \
--header 'client-id: <api-key>' \
--header 'client-secret: <api-key>' \
--data '
{
"name": "Plano Mensal Pro",
"amount": 9900,
"currency": "BRL",
"allowed_payment_types": [
"credit_card"
],
"prevent_trial_abuse": true,
"description": "Acesso completo mensal",
"custom_interval": null,
"default_trial_duration": 16
}
'import requests
url = "https://api.uvvipay.com.br/v1/subscriptions/plan"
payload = {
"name": "Plano Mensal Pro",
"amount": 9900,
"currency": "BRL",
"allowed_payment_types": ["credit_card"],
"prevent_trial_abuse": True,
"description": "Acesso completo mensal",
"custom_interval": None,
"default_trial_duration": 16
}
headers = {
"client-id": "<api-key>",
"client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'client-id': '<api-key>',
'client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Plano Mensal Pro',
amount: 9900,
currency: 'BRL',
allowed_payment_types: ['credit_card'],
prevent_trial_abuse: true,
description: 'Acesso completo mensal',
custom_interval: null,
default_trial_duration: 16
})
};
fetch('https://api.uvvipay.com.br/v1/subscriptions/plan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.uvvipay.com.br/v1/subscriptions/plan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Plano Mensal Pro',
'amount' => 9900,
'currency' => 'BRL',
'allowed_payment_types' => [
'credit_card'
],
'prevent_trial_abuse' => true,
'description' => 'Acesso completo mensal',
'custom_interval' => null,
'default_trial_duration' => 16
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"client-id: <api-key>",
"client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.uvvipay.com.br/v1/subscriptions/plan"
payload := strings.NewReader("{\n \"name\": \"Plano Mensal Pro\",\n \"amount\": 9900,\n \"currency\": \"BRL\",\n \"allowed_payment_types\": [\n \"credit_card\"\n ],\n \"prevent_trial_abuse\": true,\n \"description\": \"Acesso completo mensal\",\n \"custom_interval\": null,\n \"default_trial_duration\": 16\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("client-id", "<api-key>")
req.Header.Add("client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.uvvipay.com.br/v1/subscriptions/plan")
.header("client-id", "<api-key>")
.header("client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Plano Mensal Pro\",\n \"amount\": 9900,\n \"currency\": \"BRL\",\n \"allowed_payment_types\": [\n \"credit_card\"\n ],\n \"prevent_trial_abuse\": true,\n \"description\": \"Acesso completo mensal\",\n \"custom_interval\": null,\n \"default_trial_duration\": 16\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uvvipay.com.br/v1/subscriptions/plan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["client-id"] = '<api-key>'
request["client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Plano Mensal Pro\",\n \"amount\": 9900,\n \"currency\": \"BRL\",\n \"allowed_payment_types\": [\n \"credit_card\"\n ],\n \"prevent_trial_abuse\": true,\n \"description\": \"Acesso completo mensal\",\n \"custom_interval\": null,\n \"default_trial_duration\": 16\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"amount": 123,
"pricing_type": "FIXED_PRICE",
"currency": "<string>",
"interval": "ONE_TIME",
"custom_interval": 123,
"allowed_payment_types": [
"credit_card"
],
"default_trial_unit": "DAY",
"default_trial_duration": 123,
"prevent_trial_abuse": true,
"plan_status": "ACTIVE",
"origin": "API",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}id no campo subscription_plan_id em POST /v1/subscriptions.
Campos obrigatórios: name, amount, pricing_type, currency, interval, allowed_payment_types e prevent_trial_abuse.
Envie amount em centavos (mínimo 1, máximo 1000000). allowed_payment_types aceita credit_card, pix, ou os dois.
Depois de criado, interval e custom_interval não mudam. Se interval for CUSTOM, envie custom_interval.
Para trial padrão, envie default_trial_unit e default_trial_duration juntos (máximo 31 dias). Com prevent_trial_abuse: true, o mesmo cliente não ganha trial de novo neste plano.
Erros comuns: 400 (payload inválido), 401/403 (credenciais ou produto Recorrência).Headers
ID público da credencial do merchant
Secret da credencial do merchant
Body
Nome do plano exibido ao cliente.
"Plano Mensal Pro"
Valor em centavos (mín. 1 = R$ 0,01; máx. 1000000 = R$ 10.000,00)
1 <= x <= 10000009900
Modelo de precificação: FIXED_PRICE (valor fixo) ou PAY_WHAT_YOU_WANT.
FIXED_PRICE, PAY_WHAT_YOU_WANT Moeda ISO 4217 (ex.: BRL).
"BRL"
Cadência de cobrança. Imutável após a criação.
ONE_TIME, DAILY, WEEKLY, MONTHLY, QUARTERLY, BIANNUAL, ANNUAL, CUSTOM Métodos de pagamento aceitos pelo plano (credit_card, pix).
credit_card, pix ["credit_card"]
Bloqueia novo trial para o mesmo customer quando já houve trial no plano.
true
Descrição livre do plano.
"Acesso completo mensal"
Obrigatório quando interval = CUSTOM
null
Unidade do trial padrão do plano (DAY, WEEK, MONTH, YEAR). Use junto com default_trial_duration.
DAY, WEEK, MONTH, YEAR Duração do trial padrão do plano (máx. 31 dias)
1 <= x <= 31Response
Plano criado
Identificador do plano.
Nome do plano.
Descrição do plano.
Valor do plano em centavos.
Modelo de precificação.
FIXED_PRICE, PAY_WHAT_YOU_WANT Moeda ISO 4217.
Cadência de cobrança.
ONE_TIME, DAILY, WEEKLY, MONTHLY, QUARTERLY, BIANNUAL, ANNUAL, CUSTOM Intervalo customizado (quando interval = CUSTOM).
Métodos de pagamento aceitos.
credit_card, pix Unidade do trial padrão do plano.
DAY, WEEK, MONTH, YEAR Duração do trial padrão do plano.
Se o plano bloqueia reuso de trial pelo mesmo customer.
Situação do plano: ACTIVE ou INACTIVE.
ACTIVE, INACTIVE Origem da criação: API ou PORTAL.
API, PORTAL Data de criação do plano.
Data da última atualização do plano.

