Create Subscription
curl --request POST \
--url https://api.fungies.io/v0/subscriptions/create \
--header 'Content-Type: application/json' \
--header 'x-fngs-public-key: <api-key>' \
--header 'x-fngs-secret-key: <api-key>' \
--data '
{
"items": [
{
"name": "<string>",
"unitPrice": 123,
"quantity": 1,
"offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 8.988465674311579e+307,
"value": 8.988465674311579e+307
}
],
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userEmail": "jsmith@example.com",
"backdateStartDate": 4503599627370495,
"billingCycleAnchor": 4503599627370495,
"trialEnd": 4503599627370495,
"skipTrial": false,
"skipNotifications": false
}
'import requests
url = "https://api.fungies.io/v0/subscriptions/create"
payload = {
"items": [
{
"name": "<string>",
"unitPrice": 123,
"quantity": 1,
"offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 8.988465674311579e+307,
"value": 8.988465674311579e+307
}
],
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userEmail": "jsmith@example.com",
"backdateStartDate": 4503599627370495,
"billingCycleAnchor": 4503599627370495,
"trialEnd": 4503599627370495,
"skipTrial": False,
"skipNotifications": False
}
headers = {
"x-fngs-public-key": "<api-key>",
"x-fngs-secret-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-fngs-public-key': '<api-key>',
'x-fngs-secret-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
name: '<string>',
unitPrice: 123,
quantity: 1,
offerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
price: 8.988465674311579e+307,
value: 8.988465674311579e+307
}
],
userId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
userEmail: 'jsmith@example.com',
backdateStartDate: 4503599627370495,
billingCycleAnchor: 4503599627370495,
trialEnd: 4503599627370495,
skipTrial: false,
skipNotifications: false
})
};
fetch('https://api.fungies.io/v0/subscriptions/create', 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.fungies.io/v0/subscriptions/create",
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([
'items' => [
[
'name' => '<string>',
'unitPrice' => 123,
'quantity' => 1,
'offerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'price' => 8.988465674311579e+307,
'value' => 8.988465674311579e+307
]
],
'userId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'userEmail' => 'jsmith@example.com',
'backdateStartDate' => 4503599627370495,
'billingCycleAnchor' => 4503599627370495,
'trialEnd' => 4503599627370495,
'skipTrial' => false,
'skipNotifications' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-fngs-public-key: <api-key>",
"x-fngs-secret-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.fungies.io/v0/subscriptions/create"
payload := strings.NewReader("{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"unitPrice\": 123,\n \"quantity\": 1,\n \"offerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"price\": 8.988465674311579e+307,\n \"value\": 8.988465674311579e+307\n }\n ],\n \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"userEmail\": \"jsmith@example.com\",\n \"backdateStartDate\": 4503599627370495,\n \"billingCycleAnchor\": 4503599627370495,\n \"trialEnd\": 4503599627370495,\n \"skipTrial\": false,\n \"skipNotifications\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-fngs-public-key", "<api-key>")
req.Header.Add("x-fngs-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.fungies.io/v0/subscriptions/create")
.header("x-fngs-public-key", "<api-key>")
.header("x-fngs-secret-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"unitPrice\": 123,\n \"quantity\": 1,\n \"offerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"price\": 8.988465674311579e+307,\n \"value\": 8.988465674311579e+307\n }\n ],\n \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"userEmail\": \"jsmith@example.com\",\n \"backdateStartDate\": 4503599627370495,\n \"billingCycleAnchor\": 4503599627370495,\n \"trialEnd\": 4503599627370495,\n \"skipTrial\": false,\n \"skipNotifications\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fungies.io/v0/subscriptions/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-fngs-public-key"] = '<api-key>'
request["x-fngs-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"unitPrice\": 123,\n \"quantity\": 1,\n \"offerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"price\": 8.988465674311579e+307,\n \"value\": 8.988465674311579e+307\n }\n ],\n \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"userEmail\": \"jsmith@example.com\",\n \"backdateStartDate\": 4503599627370495,\n \"billingCycleAnchor\": 4503599627370495,\n \"trialEnd\": 4503599627370495,\n \"skipTrial\": false,\n \"skipNotifications\": false\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"data": {
"subscription": {
"id": "<string>",
"createdAt": 4503599627370495,
"currentIntervalEnd": 4503599627370495,
"currentIntervalStart": 4503599627370495,
"orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderNumber": "<string>",
"order": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"object": "order"
},
"object": "subscription",
"cancelAtIntervalEnd": false,
"canceledAt": null,
"userId": null,
"user": null,
"lastPaymentId": null,
"lastPaymentNumber": null,
"lastPayment": null
}
}
}{
"status": "error",
"error": {
"message": "Sample error message"
}
}subscriptions
Create Subscription
Create a new Subscription for a User. User must have a valid customer ID of Payment Provider set. Requires billing details with at least a country code and postal code if country is one of US, CA, UA, IN.
Multiple items (up to 20) can be billed on a single Subscription — for example a base plan plus add-ons — and each line is preserved on the invoice and outbound webhooks. Because one Subscription maps to a single billing arrangement, every item must be on the same cadence:
- Currency: all items must resolve to the same currency (from the item or its Offer).
- Billing period: all Offers must share the same recurring interval and interval count (e.g. all monthly); mixing intervals (monthly + yearly) returns a 400.
- Every item must reference a recurring Offer via offerId.
- Trial: a trial (trialEnd / the Offer trial) is only applied to single-item Subscriptions. Multi-item Subscriptions start billing immediately (no trial).
- Discount codes are not supported for multi-item Subscriptions.
Note: User must have a valid customer ID of Payment Provider set and this customer must have a valid default payment method set (Payment Provider dashboard).
POST
/
v0
/
subscriptions
/
create
Create Subscription
curl --request POST \
--url https://api.fungies.io/v0/subscriptions/create \
--header 'Content-Type: application/json' \
--header 'x-fngs-public-key: <api-key>' \
--header 'x-fngs-secret-key: <api-key>' \
--data '
{
"items": [
{
"name": "<string>",
"unitPrice": 123,
"quantity": 1,
"offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 8.988465674311579e+307,
"value": 8.988465674311579e+307
}
],
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userEmail": "jsmith@example.com",
"backdateStartDate": 4503599627370495,
"billingCycleAnchor": 4503599627370495,
"trialEnd": 4503599627370495,
"skipTrial": false,
"skipNotifications": false
}
'import requests
url = "https://api.fungies.io/v0/subscriptions/create"
payload = {
"items": [
{
"name": "<string>",
"unitPrice": 123,
"quantity": 1,
"offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 8.988465674311579e+307,
"value": 8.988465674311579e+307
}
],
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userEmail": "jsmith@example.com",
"backdateStartDate": 4503599627370495,
"billingCycleAnchor": 4503599627370495,
"trialEnd": 4503599627370495,
"skipTrial": False,
"skipNotifications": False
}
headers = {
"x-fngs-public-key": "<api-key>",
"x-fngs-secret-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-fngs-public-key': '<api-key>',
'x-fngs-secret-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
name: '<string>',
unitPrice: 123,
quantity: 1,
offerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
price: 8.988465674311579e+307,
value: 8.988465674311579e+307
}
],
userId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
userEmail: 'jsmith@example.com',
backdateStartDate: 4503599627370495,
billingCycleAnchor: 4503599627370495,
trialEnd: 4503599627370495,
skipTrial: false,
skipNotifications: false
})
};
fetch('https://api.fungies.io/v0/subscriptions/create', 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.fungies.io/v0/subscriptions/create",
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([
'items' => [
[
'name' => '<string>',
'unitPrice' => 123,
'quantity' => 1,
'offerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'price' => 8.988465674311579e+307,
'value' => 8.988465674311579e+307
]
],
'userId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'userEmail' => 'jsmith@example.com',
'backdateStartDate' => 4503599627370495,
'billingCycleAnchor' => 4503599627370495,
'trialEnd' => 4503599627370495,
'skipTrial' => false,
'skipNotifications' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-fngs-public-key: <api-key>",
"x-fngs-secret-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.fungies.io/v0/subscriptions/create"
payload := strings.NewReader("{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"unitPrice\": 123,\n \"quantity\": 1,\n \"offerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"price\": 8.988465674311579e+307,\n \"value\": 8.988465674311579e+307\n }\n ],\n \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"userEmail\": \"jsmith@example.com\",\n \"backdateStartDate\": 4503599627370495,\n \"billingCycleAnchor\": 4503599627370495,\n \"trialEnd\": 4503599627370495,\n \"skipTrial\": false,\n \"skipNotifications\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-fngs-public-key", "<api-key>")
req.Header.Add("x-fngs-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.fungies.io/v0/subscriptions/create")
.header("x-fngs-public-key", "<api-key>")
.header("x-fngs-secret-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"unitPrice\": 123,\n \"quantity\": 1,\n \"offerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"price\": 8.988465674311579e+307,\n \"value\": 8.988465674311579e+307\n }\n ],\n \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"userEmail\": \"jsmith@example.com\",\n \"backdateStartDate\": 4503599627370495,\n \"billingCycleAnchor\": 4503599627370495,\n \"trialEnd\": 4503599627370495,\n \"skipTrial\": false,\n \"skipNotifications\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fungies.io/v0/subscriptions/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-fngs-public-key"] = '<api-key>'
request["x-fngs-secret-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"unitPrice\": 123,\n \"quantity\": 1,\n \"offerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"price\": 8.988465674311579e+307,\n \"value\": 8.988465674311579e+307\n }\n ],\n \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"userEmail\": \"jsmith@example.com\",\n \"backdateStartDate\": 4503599627370495,\n \"billingCycleAnchor\": 4503599627370495,\n \"trialEnd\": 4503599627370495,\n \"skipTrial\": false,\n \"skipNotifications\": false\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"data": {
"subscription": {
"id": "<string>",
"createdAt": 4503599627370495,
"currentIntervalEnd": 4503599627370495,
"currentIntervalStart": 4503599627370495,
"orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderNumber": "<string>",
"order": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"object": "order"
},
"object": "subscription",
"cancelAtIntervalEnd": false,
"canceledAt": null,
"userId": null,
"user": null,
"lastPaymentId": null,
"lastPaymentNumber": null,
"lastPayment": null
}
}
}{
"status": "error",
"error": {
"message": "Sample error message"
}
}Body
application/json
POST /v0/subscriptions/create Request body
Required array length:
1 - 20 elementsShow child attributes
Show child attributes
Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991⌘I