Skip to main content
POST
/
v1
/
subscriptions
Create Subscription
curl --request POST \
  --url https://api.ecrypt.com/v1/subscriptions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "label": "Merchant Subscription 0001",
  "cycle": {
    "unit": "month",
    "interval": 1,
    "dayOfCycle": 1
  },
  "amount": {
    "value": 500000000
  },
  "installments": 1073741823
}
'
import requests

url = "https://api.ecrypt.com/v1/subscriptions"

payload = {
"label": "Merchant Subscription 0001",
"cycle": {
"unit": "month",
"interval": 1,
"dayOfCycle": 1
},
"amount": { "value": 500000000 },
"installments": 1073741823
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: 'Merchant Subscription 0001',
cycle: {unit: 'month', interval: 1, dayOfCycle: 1},
amount: {value: 500000000},
installments: 1073741823
})
};

fetch('https://api.ecrypt.com/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.ecrypt.com/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([
'label' => 'Merchant Subscription 0001',
'cycle' => [
'unit' => 'month',
'interval' => 1,
'dayOfCycle' => 1
],
'amount' => [
'value' => 500000000
],
'installments' => 1073741823
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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.ecrypt.com/v1/subscriptions"

payload := strings.NewReader("{\n \"label\": \"Merchant Subscription 0001\",\n \"cycle\": {\n \"unit\": \"month\",\n \"interval\": 1,\n \"dayOfCycle\": 1\n },\n \"amount\": {\n \"value\": 500000000\n },\n \"installments\": 1073741823\n}")

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

req.Header.Add("x-api-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.ecrypt.com/v1/subscriptions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"Merchant Subscription 0001\",\n \"cycle\": {\n \"unit\": \"month\",\n \"interval\": 1,\n \"dayOfCycle\": 1\n },\n \"amount\": {\n \"value\": 500000000\n },\n \"installments\": 1073741823\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.ecrypt.com/v1/subscriptions")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"Merchant Subscription 0001\",\n \"cycle\": {\n \"unit\": \"month\",\n \"interval\": 1,\n \"dayOfCycle\": 1\n },\n \"amount\": {\n \"value\": 500000000\n },\n \"installments\": 1073741823\n}"

response = http.request(request)
puts response.read_body
{
  "requestId": "000000000000000000000",
  "subscription": {
    "id": "<string>",
    "label": "<string>",
    "cycle": {
      "unit": "month",
      "interval": 1,
      "dayOfCycle": 1
    },
    "amount": {
      "value": 500000000
    },
    "installments": 1073741823
  },
  "errors": [
    {
      "type": "<string>",
      "message": "<unknown>"
    }
  ]
}
{
"requestId": "000000000000000000000",
"errors": [
{
"type": "<string>",
"message": "<unknown>"
}
]
}

Authorizations

x-api-key
string
header
required

Authorization by x-api-key inside request's header

Body

label
string
default:Merchant Subscription 0001
required
Required string length: 1 - 100
Pattern: ^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$
cycle
object | null
required
amount
object | null
required
installments
integer<int32> | null

Number of installments to run at the specified unit, and interval

Required range: 0 <= x <= 2147483647

Response

object | null

OK

requestId
string
default:000000000000000000000
required
Required string length: 1 - 100
subscription
object | null
errors
(object | null)[] | null