sign up
curl --request POST \
--url https://api.unprice.dev/v1/customers/sign-up \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "John Doe",
"email": "test@example.com",
"successUrl": "https://example.com/dashboard",
"cancelUrl": "https://example.com/login",
"timezone": "UTC",
"defaultCurrency": "USD",
"billingInterval": "month",
"planSlug": "PRO",
"sessionId": "sess_1234567890",
"planVersionId": "pv_1234567890",
"config": [
{
"featurePlanId": "feature_plan_123",
"featureSlug": "feature_slug_123",
"isUsage": true,
"units": 100
}
],
"creditLinePolicy": "uncapped",
"creditLineAmountMinor": 10000,
"externalId": "1234567890",
"metadata": {
"country": "US",
"region": "CA",
"city": "San Francisco"
}
}
'import requests
url = "https://api.unprice.dev/v1/customers/sign-up"
payload = {
"name": "John Doe",
"email": "test@example.com",
"successUrl": "https://example.com/dashboard",
"cancelUrl": "https://example.com/login",
"timezone": "UTC",
"defaultCurrency": "USD",
"billingInterval": "month",
"planSlug": "PRO",
"sessionId": "sess_1234567890",
"planVersionId": "pv_1234567890",
"config": [
{
"featurePlanId": "feature_plan_123",
"featureSlug": "feature_slug_123",
"isUsage": True,
"units": 100
}
],
"creditLinePolicy": "uncapped",
"creditLineAmountMinor": 10000,
"externalId": "1234567890",
"metadata": {
"country": "US",
"region": "CA",
"city": "San Francisco"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'John Doe',
email: 'test@example.com',
successUrl: 'https://example.com/dashboard',
cancelUrl: 'https://example.com/login',
timezone: 'UTC',
defaultCurrency: 'USD',
billingInterval: 'month',
planSlug: 'PRO',
sessionId: 'sess_1234567890',
planVersionId: 'pv_1234567890',
config: [
{
featurePlanId: 'feature_plan_123',
featureSlug: 'feature_slug_123',
isUsage: true,
units: 100
}
],
creditLinePolicy: 'uncapped',
creditLineAmountMinor: 10000,
externalId: '1234567890',
metadata: {country: 'US', region: 'CA', city: 'San Francisco'}
})
};
fetch('https://api.unprice.dev/v1/customers/sign-up', 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.unprice.dev/v1/customers/sign-up",
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' => 'John Doe',
'email' => 'test@example.com',
'successUrl' => 'https://example.com/dashboard',
'cancelUrl' => 'https://example.com/login',
'timezone' => 'UTC',
'defaultCurrency' => 'USD',
'billingInterval' => 'month',
'planSlug' => 'PRO',
'sessionId' => 'sess_1234567890',
'planVersionId' => 'pv_1234567890',
'config' => [
[
'featurePlanId' => 'feature_plan_123',
'featureSlug' => 'feature_slug_123',
'isUsage' => true,
'units' => 100
]
],
'creditLinePolicy' => 'uncapped',
'creditLineAmountMinor' => 10000,
'externalId' => '1234567890',
'metadata' => [
'country' => 'US',
'region' => 'CA',
'city' => 'San Francisco'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.unprice.dev/v1/customers/sign-up"
payload := strings.NewReader("{\n \"name\": \"John Doe\",\n \"email\": \"test@example.com\",\n \"successUrl\": \"https://example.com/dashboard\",\n \"cancelUrl\": \"https://example.com/login\",\n \"timezone\": \"UTC\",\n \"defaultCurrency\": \"USD\",\n \"billingInterval\": \"month\",\n \"planSlug\": \"PRO\",\n \"sessionId\": \"sess_1234567890\",\n \"planVersionId\": \"pv_1234567890\",\n \"config\": [\n {\n \"featurePlanId\": \"feature_plan_123\",\n \"featureSlug\": \"feature_slug_123\",\n \"isUsage\": true,\n \"units\": 100\n }\n ],\n \"creditLinePolicy\": \"uncapped\",\n \"creditLineAmountMinor\": 10000,\n \"externalId\": \"1234567890\",\n \"metadata\": {\n \"country\": \"US\",\n \"region\": \"CA\",\n \"city\": \"San Francisco\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.unprice.dev/v1/customers/sign-up")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"John Doe\",\n \"email\": \"test@example.com\",\n \"successUrl\": \"https://example.com/dashboard\",\n \"cancelUrl\": \"https://example.com/login\",\n \"timezone\": \"UTC\",\n \"defaultCurrency\": \"USD\",\n \"billingInterval\": \"month\",\n \"planSlug\": \"PRO\",\n \"sessionId\": \"sess_1234567890\",\n \"planVersionId\": \"pv_1234567890\",\n \"config\": [\n {\n \"featurePlanId\": \"feature_plan_123\",\n \"featureSlug\": \"feature_slug_123\",\n \"isUsage\": true,\n \"units\": 100\n }\n ],\n \"creditLinePolicy\": \"uncapped\",\n \"creditLineAmountMinor\": 10000,\n \"externalId\": \"1234567890\",\n \"metadata\": {\n \"country\": \"US\",\n \"region\": \"CA\",\n \"city\": \"San Francisco\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unprice.dev/v1/customers/sign-up")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"John Doe\",\n \"email\": \"test@example.com\",\n \"successUrl\": \"https://example.com/dashboard\",\n \"cancelUrl\": \"https://example.com/login\",\n \"timezone\": \"UTC\",\n \"defaultCurrency\": \"USD\",\n \"billingInterval\": \"month\",\n \"planSlug\": \"PRO\",\n \"sessionId\": \"sess_1234567890\",\n \"planVersionId\": \"pv_1234567890\",\n \"config\": [\n {\n \"featurePlanId\": \"feature_plan_123\",\n \"featureSlug\": \"feature_slug_123\",\n \"isUsage\": true,\n \"units\": 100\n }\n ],\n \"creditLinePolicy\": \"uncapped\",\n \"creditLineAmountMinor\": 10000,\n \"externalId\": \"1234567890\",\n \"metadata\": {\n \"country\": \"US\",\n \"region\": \"CA\",\n \"city\": \"San Francisco\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"url": "https://example.com/dashboard",
"customerId": "cus_1234567890"
}{
"error": {
"code": "BAD_REQUEST",
"docs": "https://docs.unprice.dev/api-reference/errors/code/BAD_REQUEST",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"docs": "https://docs.unprice.dev/api-reference/errors/code/UNAUTHORIZED",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "FORBIDDEN",
"docs": "https://docs.unprice.dev/api-reference/errors/code/FORBIDDEN",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "NOT_FOUND",
"docs": "https://docs.unprice.dev/api-reference/errors/code/NOT_FOUND",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "CONFLICT",
"docs": "https://docs.unprice.dev/api-reference/errors/code/CONFLICT",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "PRECONDITION_FAILED",
"docs": "https://docs.unprice.dev/api-reference/errors/code/PRECONDITION_FAILED",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "PAYLOAD_TOO_LARGE",
"docs": "https://docs.unprice.dev/api-reference/errors/code/PAYLOAD_TOO_LARGE",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "TOO_MANY_REQUESTS",
"docs": "https://docs.unprice.dev/api-reference/errors/code/TOO_MANY_REQUESTS",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"docs": "https://docs.unprice.dev/api-reference/errors/code/INTERNAL_SERVER_ERROR",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}customers
sign up
Sign up a customer for a project
POST
/
v1
/
customers
/
sign-up
sign up
curl --request POST \
--url https://api.unprice.dev/v1/customers/sign-up \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "John Doe",
"email": "test@example.com",
"successUrl": "https://example.com/dashboard",
"cancelUrl": "https://example.com/login",
"timezone": "UTC",
"defaultCurrency": "USD",
"billingInterval": "month",
"planSlug": "PRO",
"sessionId": "sess_1234567890",
"planVersionId": "pv_1234567890",
"config": [
{
"featurePlanId": "feature_plan_123",
"featureSlug": "feature_slug_123",
"isUsage": true,
"units": 100
}
],
"creditLinePolicy": "uncapped",
"creditLineAmountMinor": 10000,
"externalId": "1234567890",
"metadata": {
"country": "US",
"region": "CA",
"city": "San Francisco"
}
}
'import requests
url = "https://api.unprice.dev/v1/customers/sign-up"
payload = {
"name": "John Doe",
"email": "test@example.com",
"successUrl": "https://example.com/dashboard",
"cancelUrl": "https://example.com/login",
"timezone": "UTC",
"defaultCurrency": "USD",
"billingInterval": "month",
"planSlug": "PRO",
"sessionId": "sess_1234567890",
"planVersionId": "pv_1234567890",
"config": [
{
"featurePlanId": "feature_plan_123",
"featureSlug": "feature_slug_123",
"isUsage": True,
"units": 100
}
],
"creditLinePolicy": "uncapped",
"creditLineAmountMinor": 10000,
"externalId": "1234567890",
"metadata": {
"country": "US",
"region": "CA",
"city": "San Francisco"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'John Doe',
email: 'test@example.com',
successUrl: 'https://example.com/dashboard',
cancelUrl: 'https://example.com/login',
timezone: 'UTC',
defaultCurrency: 'USD',
billingInterval: 'month',
planSlug: 'PRO',
sessionId: 'sess_1234567890',
planVersionId: 'pv_1234567890',
config: [
{
featurePlanId: 'feature_plan_123',
featureSlug: 'feature_slug_123',
isUsage: true,
units: 100
}
],
creditLinePolicy: 'uncapped',
creditLineAmountMinor: 10000,
externalId: '1234567890',
metadata: {country: 'US', region: 'CA', city: 'San Francisco'}
})
};
fetch('https://api.unprice.dev/v1/customers/sign-up', 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.unprice.dev/v1/customers/sign-up",
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' => 'John Doe',
'email' => 'test@example.com',
'successUrl' => 'https://example.com/dashboard',
'cancelUrl' => 'https://example.com/login',
'timezone' => 'UTC',
'defaultCurrency' => 'USD',
'billingInterval' => 'month',
'planSlug' => 'PRO',
'sessionId' => 'sess_1234567890',
'planVersionId' => 'pv_1234567890',
'config' => [
[
'featurePlanId' => 'feature_plan_123',
'featureSlug' => 'feature_slug_123',
'isUsage' => true,
'units' => 100
]
],
'creditLinePolicy' => 'uncapped',
'creditLineAmountMinor' => 10000,
'externalId' => '1234567890',
'metadata' => [
'country' => 'US',
'region' => 'CA',
'city' => 'San Francisco'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.unprice.dev/v1/customers/sign-up"
payload := strings.NewReader("{\n \"name\": \"John Doe\",\n \"email\": \"test@example.com\",\n \"successUrl\": \"https://example.com/dashboard\",\n \"cancelUrl\": \"https://example.com/login\",\n \"timezone\": \"UTC\",\n \"defaultCurrency\": \"USD\",\n \"billingInterval\": \"month\",\n \"planSlug\": \"PRO\",\n \"sessionId\": \"sess_1234567890\",\n \"planVersionId\": \"pv_1234567890\",\n \"config\": [\n {\n \"featurePlanId\": \"feature_plan_123\",\n \"featureSlug\": \"feature_slug_123\",\n \"isUsage\": true,\n \"units\": 100\n }\n ],\n \"creditLinePolicy\": \"uncapped\",\n \"creditLineAmountMinor\": 10000,\n \"externalId\": \"1234567890\",\n \"metadata\": {\n \"country\": \"US\",\n \"region\": \"CA\",\n \"city\": \"San Francisco\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.unprice.dev/v1/customers/sign-up")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"John Doe\",\n \"email\": \"test@example.com\",\n \"successUrl\": \"https://example.com/dashboard\",\n \"cancelUrl\": \"https://example.com/login\",\n \"timezone\": \"UTC\",\n \"defaultCurrency\": \"USD\",\n \"billingInterval\": \"month\",\n \"planSlug\": \"PRO\",\n \"sessionId\": \"sess_1234567890\",\n \"planVersionId\": \"pv_1234567890\",\n \"config\": [\n {\n \"featurePlanId\": \"feature_plan_123\",\n \"featureSlug\": \"feature_slug_123\",\n \"isUsage\": true,\n \"units\": 100\n }\n ],\n \"creditLinePolicy\": \"uncapped\",\n \"creditLineAmountMinor\": 10000,\n \"externalId\": \"1234567890\",\n \"metadata\": {\n \"country\": \"US\",\n \"region\": \"CA\",\n \"city\": \"San Francisco\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.unprice.dev/v1/customers/sign-up")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"John Doe\",\n \"email\": \"test@example.com\",\n \"successUrl\": \"https://example.com/dashboard\",\n \"cancelUrl\": \"https://example.com/login\",\n \"timezone\": \"UTC\",\n \"defaultCurrency\": \"USD\",\n \"billingInterval\": \"month\",\n \"planSlug\": \"PRO\",\n \"sessionId\": \"sess_1234567890\",\n \"planVersionId\": \"pv_1234567890\",\n \"config\": [\n {\n \"featurePlanId\": \"feature_plan_123\",\n \"featureSlug\": \"feature_slug_123\",\n \"isUsage\": true,\n \"units\": 100\n }\n ],\n \"creditLinePolicy\": \"uncapped\",\n \"creditLineAmountMinor\": 10000,\n \"externalId\": \"1234567890\",\n \"metadata\": {\n \"country\": \"US\",\n \"region\": \"CA\",\n \"city\": \"San Francisco\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"url": "https://example.com/dashboard",
"customerId": "cus_1234567890"
}{
"error": {
"code": "BAD_REQUEST",
"docs": "https://docs.unprice.dev/api-reference/errors/code/BAD_REQUEST",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"docs": "https://docs.unprice.dev/api-reference/errors/code/UNAUTHORIZED",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "FORBIDDEN",
"docs": "https://docs.unprice.dev/api-reference/errors/code/FORBIDDEN",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "NOT_FOUND",
"docs": "https://docs.unprice.dev/api-reference/errors/code/NOT_FOUND",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "CONFLICT",
"docs": "https://docs.unprice.dev/api-reference/errors/code/CONFLICT",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "PRECONDITION_FAILED",
"docs": "https://docs.unprice.dev/api-reference/errors/code/PRECONDITION_FAILED",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "PAYLOAD_TOO_LARGE",
"docs": "https://docs.unprice.dev/api-reference/errors/code/PAYLOAD_TOO_LARGE",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "TOO_MANY_REQUESTS",
"docs": "https://docs.unprice.dev/api-reference/errors/code/TOO_MANY_REQUESTS",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"docs": "https://docs.unprice.dev/api-reference/errors/code/INTERNAL_SERVER_ERROR",
"message": "<string>",
"requestId": "req_1234",
"details": {
"kind": "invalid_config",
"issues": [
{
"path": "config.plans[0].version.features[1].featureSlug",
"message": "<string>"
}
]
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Body of the request
The customer sign up request
The name of the customer
Minimum string length:
1Example:
"John Doe"
The email of the customer
Minimum string length:
1Example:
"test@example.com"
The success url if the customer signs up. This is the url after the signup process, normally your dashboard
Example:
"https://example.com/dashboard"
The cancel url if the customer cancels the signup. This is the url after the signup process, normally your login page
Example:
"https://example.com/login"
The timezone of the customer, if passed null the system will use the project timezone
Example:
"UTC"
The default currency of the customer, if passed null the system will use the project currency
Available options:
USD, EUR Example:
"USD"
The billing interval of the customer to be used for the subscription. If plan version is provided, the billing interval will be the same as the plan version. If plan slug is provided, the billing interval will be the default billing interval of the plan.
Available options:
month, year, week, day, minute, onetime Example:
"month"
If provided, the system will intelligently pick the latest plan version for that slug and sign up the customer for it. If omitted with planVersionId, the default plan is used.
Example:
"PRO"
The session id of the customer. This is used to track conversion from pricing pages
Example:
"sess_1234567890"
The plan version the customer is signing up for
Example:
"pv_1234567890"
The configuration of the subscription items. This is required if your features are quantity based when the customer needs to set them. Pass as empty if you want the system to automatically set the units from the plan defaults.
Show child attributes
Show child attributes
Example:
[
{
"featurePlanId": "feature_plan_123",
"featureSlug": "feature_slug_123",
"isUsage": true,
"units": 100
}
]
Usage credit policy for the initial subscription phase. Uncapped allows postpaid usage without wallet reservation; capped uses a finite credit amount or derives one from finite usage limits.
Available options:
capped, uncapped Example:
"uncapped"
Optional capped usage credit amount in the currency's minor unit. For USD/EUR, 10000 means 100.00. Leave null or omit to derive from finite usage limits when creditLinePolicy is capped.
Required range:
-9007199254740991 <= x <= 9007199254740991Example:
10000
The external id you want to associate with the customer. Could be the id of the user in your database
Example:
"1234567890"
The metadata of the customer, very important to pass geolocation data if you want to segment later on
Show child attributes
Show child attributes
Example:
{
"country": "US",
"region": "CA",
"city": "San Francisco"
}
Response
The result of the customer sign up
Whether the signup was successful
Example:
true
The url to redirect the customer to, either to the success or cancel url
Example:
"https://example.com/dashboard"
The unprice customer id generated by the system for this customer
Example:
"cus_1234567890"