curl --request PUT \
--url https://api-global.fastpaybrasil.com/v1/subscription-plans/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"merchantId": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
"name": "Plano Premium Atualizado",
"price": 119.9,
"currency": "BRL",
"recurrenceInterval": 123,
"endDate": "2023-12-25",
"buyerMessage": "<string>",
"paymentMethods": [
"<string>"
]
}
'import requests
url = "https://api-global.fastpaybrasil.com/v1/subscription-plans/{id}"
payload = {
"merchantId": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
"name": "Plano Premium Atualizado",
"price": 119.9,
"currency": "BRL",
"recurrenceInterval": 123,
"endDate": "2023-12-25",
"buyerMessage": "<string>",
"paymentMethods": ["<string>"]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
merchantId: '2RhQg9M7ZCg3X3nMb9W1kX8Q',
name: 'Plano Premium Atualizado',
price: 119.9,
currency: 'BRL',
recurrenceInterval: 123,
endDate: '2023-12-25',
buyerMessage: '<string>',
paymentMethods: ['<string>']
})
};
fetch('https://api-global.fastpaybrasil.com/v1/subscription-plans/{id}', 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-global.fastpaybrasil.com/v1/subscription-plans/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'merchantId' => '2RhQg9M7ZCg3X3nMb9W1kX8Q',
'name' => 'Plano Premium Atualizado',
'price' => 119.9,
'currency' => 'BRL',
'recurrenceInterval' => 123,
'endDate' => '2023-12-25',
'buyerMessage' => '<string>',
'paymentMethods' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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-global.fastpaybrasil.com/v1/subscription-plans/{id}"
payload := strings.NewReader("{\n \"merchantId\": \"2RhQg9M7ZCg3X3nMb9W1kX8Q\",\n \"name\": \"Plano Premium Atualizado\",\n \"price\": 119.9,\n \"currency\": \"BRL\",\n \"recurrenceInterval\": 123,\n \"endDate\": \"2023-12-25\",\n \"buyerMessage\": \"<string>\",\n \"paymentMethods\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.put("https://api-global.fastpaybrasil.com/v1/subscription-plans/{id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"merchantId\": \"2RhQg9M7ZCg3X3nMb9W1kX8Q\",\n \"name\": \"Plano Premium Atualizado\",\n \"price\": 119.9,\n \"currency\": \"BRL\",\n \"recurrenceInterval\": 123,\n \"endDate\": \"2023-12-25\",\n \"buyerMessage\": \"<string>\",\n \"paymentMethods\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-global.fastpaybrasil.com/v1/subscription-plans/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"merchantId\": \"2RhQg9M7ZCg3X3nMb9W1kX8Q\",\n \"name\": \"Plano Premium Atualizado\",\n \"price\": 119.9,\n \"currency\": \"BRL\",\n \"recurrenceInterval\": 123,\n \"endDate\": \"2023-12-25\",\n \"buyerMessage\": \"<string>\",\n \"paymentMethods\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
"merchantId": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
"name": "Plano Premium Mensal",
"price": 99.9,
"currency": "BRL",
"recurrenceType": "monthly",
"recurrenceInterval": null,
"endDate": null,
"buyerMessage": "Bem-vindo ao Plano Premium!",
"paymentMethods": [
"credit_card"
],
"imageUrl": "https://storage.example.com/plans/image.png",
"status": "active",
"activeSubscriptionsCount": 150,
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z"
}{
"statusCode": 401,
"message": "Unauthorized"
}{
"statusCode": 404,
"message": "Subscription plan not found"
}Update subscription plan
Updates an existing subscription plan. Changes do NOT affect existing subscriptions, only new subscriptions will use the updated values.
curl --request PUT \
--url https://api-global.fastpaybrasil.com/v1/subscription-plans/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"merchantId": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
"name": "Plano Premium Atualizado",
"price": 119.9,
"currency": "BRL",
"recurrenceInterval": 123,
"endDate": "2023-12-25",
"buyerMessage": "<string>",
"paymentMethods": [
"<string>"
]
}
'import requests
url = "https://api-global.fastpaybrasil.com/v1/subscription-plans/{id}"
payload = {
"merchantId": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
"name": "Plano Premium Atualizado",
"price": 119.9,
"currency": "BRL",
"recurrenceInterval": 123,
"endDate": "2023-12-25",
"buyerMessage": "<string>",
"paymentMethods": ["<string>"]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
merchantId: '2RhQg9M7ZCg3X3nMb9W1kX8Q',
name: 'Plano Premium Atualizado',
price: 119.9,
currency: 'BRL',
recurrenceInterval: 123,
endDate: '2023-12-25',
buyerMessage: '<string>',
paymentMethods: ['<string>']
})
};
fetch('https://api-global.fastpaybrasil.com/v1/subscription-plans/{id}', 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-global.fastpaybrasil.com/v1/subscription-plans/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'merchantId' => '2RhQg9M7ZCg3X3nMb9W1kX8Q',
'name' => 'Plano Premium Atualizado',
'price' => 119.9,
'currency' => 'BRL',
'recurrenceInterval' => 123,
'endDate' => '2023-12-25',
'buyerMessage' => '<string>',
'paymentMethods' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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-global.fastpaybrasil.com/v1/subscription-plans/{id}"
payload := strings.NewReader("{\n \"merchantId\": \"2RhQg9M7ZCg3X3nMb9W1kX8Q\",\n \"name\": \"Plano Premium Atualizado\",\n \"price\": 119.9,\n \"currency\": \"BRL\",\n \"recurrenceInterval\": 123,\n \"endDate\": \"2023-12-25\",\n \"buyerMessage\": \"<string>\",\n \"paymentMethods\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.put("https://api-global.fastpaybrasil.com/v1/subscription-plans/{id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"merchantId\": \"2RhQg9M7ZCg3X3nMb9W1kX8Q\",\n \"name\": \"Plano Premium Atualizado\",\n \"price\": 119.9,\n \"currency\": \"BRL\",\n \"recurrenceInterval\": 123,\n \"endDate\": \"2023-12-25\",\n \"buyerMessage\": \"<string>\",\n \"paymentMethods\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-global.fastpaybrasil.com/v1/subscription-plans/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"merchantId\": \"2RhQg9M7ZCg3X3nMb9W1kX8Q\",\n \"name\": \"Plano Premium Atualizado\",\n \"price\": 119.9,\n \"currency\": \"BRL\",\n \"recurrenceInterval\": 123,\n \"endDate\": \"2023-12-25\",\n \"buyerMessage\": \"<string>\",\n \"paymentMethods\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
"merchantId": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
"name": "Plano Premium Mensal",
"price": 99.9,
"currency": "BRL",
"recurrenceType": "monthly",
"recurrenceInterval": null,
"endDate": null,
"buyerMessage": "Bem-vindo ao Plano Premium!",
"paymentMethods": [
"credit_card"
],
"imageUrl": "https://storage.example.com/plans/image.png",
"status": "active",
"activeSubscriptionsCount": 150,
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z"
}{
"statusCode": 401,
"message": "Unauthorized"
}{
"statusCode": 404,
"message": "Subscription plan not found"
}Authorizations
HTTP Basic authentication. Use your secret key as the username and an empty string as password. The API key should be base64 encoded in the format 'username:' when sending the Authorization header.
Path Parameters
Unique subscription plan identifier
Body
Merchant ID (required for validation)
"2RhQg9M7ZCg3X3nMb9W1kX8Q"
Plan name
"Plano Premium Atualizado"
New plan price
119.9
Currency code
"BRL"
Recurrence type
weekly, biweekly, monthly, custom Custom recurrence interval in months
Plan end date
Message displayed to buyer
Accepted payment methods
Response
Subscription plan successfully updated
Unique plan identifier
"2RhQg9M7ZCg3X3nMb9W1kX8Q"
Merchant ID
"2RhQg9M7ZCg3X3nMb9W1kX8Q"
Plan name
"Plano Premium Mensal"
Plan price
99.9
Currency code
"BRL"
Recurrence type
weekly, biweekly, monthly, custom "monthly"
Custom recurrence interval in months
null
Plan end date
null
Message displayed to buyer
"Bem-vindo ao Plano Premium!"
Accepted payment methods
["credit_card"]
Plan image URL
"https://storage.example.com/plans/image.png"
Plan status
active, inactive "active"
Number of active subscriptions
150
Creation timestamp
"2024-01-15T10:30:00.000Z"
Last update timestamp
"2024-01-15T10:30:00.000Z"