Create Subscription

POST

subscriptions

Create subscription

curl --request POST \
  --url https://api-sandbox.y.uno/v1/subscriptions \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "customer_id": "c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f",
  "amount": {
    "currency": "BRL",
    "value": 49.9
  },
  "country": "BR",
  "interval": "MONTHLY",
  "payment_method_id": "pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  "description": "Premium Plan - Monthly"
}
'

import requests

url = "https://api-sandbox.y.uno/v1/subscriptions"

payload = {
    "customer_id": "c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f",
    "amount": {
        "currency": "BRL",
        "value": 49.9
    },
    "country": "BR",
    "interval": "MONTHLY",
    "payment_method_id": "pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890",
    "description": "Premium Plan - Monthly"
}
headers = {
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'public-api-key': '<api-key>',
    'private-secret-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customer_id: 'c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f',
    amount: {currency: 'BRL', value: 49.9},
    country: 'BR',
    interval: 'MONTHLY',
    payment_method_id: 'pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890',
    description: 'Premium Plan - Monthly'
  })
};

fetch('https://api-sandbox.y.uno/v1/subscriptions', 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-sandbox.y.uno/v1/subscriptions",
  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([
    'customer_id' => 'c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f',
    'amount' => [
        'currency' => 'BRL',
        'value' => 49.9
    ],
    'country' => 'BR',
    'interval' => 'MONTHLY',
    'payment_method_id' => 'pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890',
    'description' => 'Premium Plan - Monthly'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "private-secret-key: <api-key>",
    "public-api-key: <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-sandbox.y.uno/v1/subscriptions"

	payload := strings.NewReader("{\n  \"customer_id\": \"c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f\",\n  \"amount\": {\n    \"currency\": \"BRL\",\n    \"value\": 49.9\n  },\n  \"country\": \"BR\",\n  \"interval\": \"MONTHLY\",\n  \"payment_method_id\": \"pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890\",\n  \"description\": \"Premium Plan - Monthly\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("public-api-key", "<api-key>")
	req.Header.Add("private-secret-key", "<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-sandbox.y.uno/v1/subscriptions")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f\",\n  \"amount\": {\n    \"currency\": \"BRL\",\n    \"value\": 49.9\n  },\n  \"country\": \"BR\",\n  \"interval\": \"MONTHLY\",\n  \"payment_method_id\": \"pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890\",\n  \"description\": \"Premium Plan - Monthly\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/subscriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f\",\n  \"amount\": {\n    \"currency\": \"BRL\",\n    \"value\": 49.9\n  },\n  \"country\": \"BR\",\n  \"interval\": \"MONTHLY\",\n  \"payment_method_id\": \"pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890\",\n  \"description\": \"Premium Plan - Monthly\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": {
    "currency": "BRL",
    "value": 100
  },
  "next_payment_date": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "amount must be greater than 0",
    "country must not be blank"
  ]
}

Authorizations

public-api-key

string

header

required

Your public API key from the Yuno Dashboard

private-secret-key

string

header

required

Your private secret key (server-side only)

Body

application/json

customer_id

string<uuid>

required

The customer for this subscription

Example:

"c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f"

amount

object

required

Show child attributes

Example:

{ "currency": "BRL", "value": 100 }

country

string

required

ISO 3166-1 alpha-2 country code

Pattern: ^[A-Z]{2}$

Example:

"BR"

interval

enum<string>

required

Billing interval

Available options:

DAILY,

WEEKLY,

MONTHLY,

YEARLY

Example:

"MONTHLY"

payment_method_id

string<uuid>

Enrolled payment method to charge

Example:

"pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890"

description

string

Subscription description

Example:

"Premium Plan - Monthly"

start_date

string<date-time>

When to start billing

Example:

"2026-03-01T00:00:00.000Z"

Response

Subscription created successfully

string<uuid>

status

enum<string>

Available options:

ACTIVE,

PAUSED,

CANCELLED,

PAST_DUE,

EXPIRED

amount

object

Show child attributes

Example:

{ "currency": "BRL", "value": 100 }

interval

enum<string>

Available options:

DAILY,

WEEKLY,

MONTHLY,

YEARLY

next_payment_date

string<date-time>

created_at

string<date-time>

updated_at

string<date-time>

Create subscription

curl --request POST \
  --url https://api-sandbox.y.uno/v1/subscriptions \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "customer_id": "c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f",
  "amount": {
    "currency": "BRL",
    "value": 49.9
  },
  "country": "BR",
  "interval": "MONTHLY",
  "payment_method_id": "pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  "description": "Premium Plan - Monthly"
}
'

import requests

url = "https://api-sandbox.y.uno/v1/subscriptions"

payload = {
    "customer_id": "c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f",
    "amount": {
        "currency": "BRL",
        "value": 49.9
    },
    "country": "BR",
    "interval": "MONTHLY",
    "payment_method_id": "pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890",
    "description": "Premium Plan - Monthly"
}
headers = {
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'public-api-key': '<api-key>',
    'private-secret-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customer_id: 'c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f',
    amount: {currency: 'BRL', value: 49.9},
    country: 'BR',
    interval: 'MONTHLY',
    payment_method_id: 'pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890',
    description: 'Premium Plan - Monthly'
  })
};

fetch('https://api-sandbox.y.uno/v1/subscriptions', 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-sandbox.y.uno/v1/subscriptions",
  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([
    'customer_id' => 'c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f',
    'amount' => [
        'currency' => 'BRL',
        'value' => 49.9
    ],
    'country' => 'BR',
    'interval' => 'MONTHLY',
    'payment_method_id' => 'pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890',
    'description' => 'Premium Plan - Monthly'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "private-secret-key: <api-key>",
    "public-api-key: <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-sandbox.y.uno/v1/subscriptions"

	payload := strings.NewReader("{\n  \"customer_id\": \"c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f\",\n  \"amount\": {\n    \"currency\": \"BRL\",\n    \"value\": 49.9\n  },\n  \"country\": \"BR\",\n  \"interval\": \"MONTHLY\",\n  \"payment_method_id\": \"pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890\",\n  \"description\": \"Premium Plan - Monthly\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("public-api-key", "<api-key>")
	req.Header.Add("private-secret-key", "<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-sandbox.y.uno/v1/subscriptions")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f\",\n  \"amount\": {\n    \"currency\": \"BRL\",\n    \"value\": 49.9\n  },\n  \"country\": \"BR\",\n  \"interval\": \"MONTHLY\",\n  \"payment_method_id\": \"pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890\",\n  \"description\": \"Premium Plan - Monthly\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/subscriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f\",\n  \"amount\": {\n    \"currency\": \"BRL\",\n    \"value\": 49.9\n  },\n  \"country\": \"BR\",\n  \"interval\": \"MONTHLY\",\n  \"payment_method_id\": \"pm_1a2b3c4d-5e6f-7890-abcd-ef1234567890\",\n  \"description\": \"Premium Plan - Monthly\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": {
    "currency": "BRL",
    "value": 100
  },
  "next_payment_date": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "amount must be greater than 0",
    "country must not be blank"
  ]
}

Getting started

Conventions

Core

Recurring

Hosted

Marketplace

Embedded finance

Operations

Recovery

Reference data

Authorizations

Body

Response