Merchants (API) | เอกสารประกอบ Accountmaker

Merchant catalog, pricing, and provider configuration

GET/api/applications/{application_id}/merchants

List all merchants configured for an account. Returns payment providers like Stripe, Polar, etc.

Responses

200application/json

schemaobject

dataarrayrequired

itemMerchantrequired

A merchant configuration for an account that accepts payments. Supports multiple providers like Stripe, Polar, or manual billing.

idstringrequired

Unique identifier for a merchant.

application_idstringrequired

Unique identifier for an application.

providerrequired

configobjectrequired

Variant

Option 1object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 2object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 3object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 4object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 5object

Nested fields truncated. Expand to continue inline, or use the model link.

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/applications/app2abc123/merchants" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/applications/app2abc123/merchants";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/applications/app2abc123/merchants";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/applications/app2abc123/merchants",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/applications/app2abc123/merchants",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/applications/app2abc123/merchants", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/applications/app2abc123/merchants", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/applications/app2abc123/merchants", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/applications/app2abc123/merchants", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/applications/app2abc123/merchants")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/applications/app2abc123/merchants", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/applications/app2abc123/merchants");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/applications/{application_id}/merchants

Create a new merchant (payment provider) for an account. Each account can have one merchant per provider.

Bodyapplication/json

providerrequired

configobjectrequired

Variant

Option 1object

providerrequired

publishable_keystring | nullrequired

connected_account_idstring | null

portal_configuration_idstring | nullrequired

Option 2object

providerrequired

organization_idstring | nullrequired

Option 3object

providerrequired

invoice_emailstring | nullrequired

payment_instructionsstring | nullrequired

Option 4object

providerrequired

profile_idstring | nullrequired

Option 5object

providerrequired

store_idstring | nullrequired

secretsobject

Variant

Option 1object

providerrequired

secret_keystringrequired

webhook_secretstringrequired

Option 2object

providerrequired

api_keystringrequired

webhook_secretstringrequired

Option 3object

providerrequired

Option 4object

providerrequired

api_keystringrequired

Option 5object

providerrequired

api_keystringrequired

webhook_secretstringrequired

Responses

201application/json

Merchant created

schemaobject

dataMerchantrequired

A merchant configuration for an account that accepts payments. Supports multiple providers like Stripe, Polar, or manual billing.

idstringrequired

Unique identifier for a merchant.

application_idstringrequired

Unique identifier for an application.

providerrequired

configobjectrequired

Variant

Option 1object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 2object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 3object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 4object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 5object

Nested fields truncated. Expand to continue inline, or use the model link.

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

409

Merchant already exists for this provider

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/applications/app2abc123/merchants" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"provider":"stripe","config":"value","secrets":"value"}'

const payload = {"provider":"stripe","config":"value","secrets":"value"};
const url = "${BASE_URL}/api/applications/app2abc123/merchants";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"provider":"stripe","config":"value","secrets":"value"};
const url = "${BASE_URL}/api/applications/app2abc123/merchants";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"provider":"stripe","config":"value","secrets":"value"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app2abc123/merchants",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"provider":"stripe","config":"value","secrets":"value"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app2abc123/merchants",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"provider":"stripe","config":"value","secrets":"value"};
const { body } = await request("${BASE_URL}/api/applications/app2abc123/merchants", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"provider":"stripe","config":"value","secrets":"value"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/applications/app2abc123/merchants", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"provider":"stripe","config":"value","secrets":"value"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/applications/app2abc123/merchants", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"provider":"stripe","config":"value","secrets":"value"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/applications/app2abc123/merchants", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"provider":"stripe","config":"value","secrets":"value"}
uri = URI("${BASE_URL}/api/applications/app2abc123/merchants")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"provider":"stripe","config":"value","secrets":"value"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/applications/app2abc123/merchants", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/applications/app2abc123/merchants");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"provider\":\"stripe\",\"config\":\"value\",\"secrets\":\"value\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

DELETE/api/merchants/{merchant_id}

Delete a merchant and all associated products, prices, and features. This is irreversible.

Responses

204

Merchant deleted

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

404application/problem+jsonProblemDetails

Not Found

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X DELETE \\
  "${BASE_URL}/api/merchants/string" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/merchants/string";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/merchants/string";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "delete",
  url: "${BASE_URL}/api/merchants/string",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "delete",
  url: "${BASE_URL}/api/merchants/string",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/merchants/string", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "DELETE", \
    "${BASE_URL}/api/merchants/string", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "DELETE", \
        "${BASE_URL}/api/merchants/string", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("DELETE", "${BASE_URL}/api/merchants/string", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/merchants/string")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("DELETE", "${BASE_URL}/api/merchants/string", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "${BASE_URL}/api/merchants/string");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/merchants/{merchant_id}

Retrieve a merchant by ID. Returns the merchant’s provider and configuration.

Responses

200application/json

schemaobject

dataMerchantrequired

A merchant configuration for an account that accepts payments. Supports multiple providers like Stripe, Polar, or manual billing.

idstringrequired

Unique identifier for a merchant.

application_idstringrequired

Unique identifier for an application.

providerrequired

configobjectrequired

Variant

Option 1object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 2object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 3object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 4object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 5object

Nested fields truncated. Expand to continue inline, or use the model link.

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

404application/problem+jsonProblemDetails

Not Found

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/merchants/string" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/merchants/string";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/merchants/string";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/merchants/string",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/merchants/string",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/merchants/string", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/merchants/string", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/merchants/string", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/merchants/string", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/merchants/string")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/merchants/string", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/merchants/string");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/merchants/{merchant_id}

Update a merchant’s configuration or secrets. Provider cannot be changed after creation.

Bodyapplication/json

configobject

Variant

Option 1object

providerrequired

publishable_keystring | nullrequired

connected_account_idstring | null

portal_configuration_idstring | nullrequired

Option 2object

providerrequired

organization_idstring | nullrequired

Option 3object

providerrequired

invoice_emailstring | nullrequired

payment_instructionsstring | nullrequired

Option 4object

providerrequired

profile_idstring | nullrequired

Option 5object

providerrequired

store_idstring | nullrequired

secretsobject

Variant

Option 1object

providerrequired

secret_keystringrequired

webhook_secretstringrequired

Option 2object

providerrequired

api_keystringrequired

webhook_secretstringrequired

Option 3object

providerrequired

Option 4object

providerrequired

api_keystringrequired

Option 5object

providerrequired

api_keystringrequired

webhook_secretstringrequired

Responses

200application/json

Merchant updated

schemaobject

dataMerchantrequired

A merchant configuration for an account that accepts payments. Supports multiple providers like Stripe, Polar, or manual billing.

idstringrequired

Unique identifier for a merchant.

application_idstringrequired

Unique identifier for an application.

providerrequired

configobjectrequired

Variant

Option 1object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 2object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 3object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 4object

Nested fields truncated. Expand to continue inline, or use the model link.

Option 5object

Nested fields truncated. Expand to continue inline, or use the model link.

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

404application/problem+jsonProblemDetails

Not Found

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X PATCH \\
  "${BASE_URL}/api/merchants/string" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"config":"value","secrets":"value"}'

const payload = {"config":"value","secrets":"value"};
const url = "${BASE_URL}/api/merchants/string";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"config":"value","secrets":"value"};
const url = "${BASE_URL}/api/merchants/string";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"config":"value","secrets":"value"};
const response = await axios({
  method: "patch",
  url: "${BASE_URL}/api/merchants/string",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"config":"value","secrets":"value"};
const response: AxiosResponse = await axios({
  method: "patch",
  url: "${BASE_URL}/api/merchants/string",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"config":"value","secrets":"value"};
const { body } = await request("${BASE_URL}/api/merchants/string", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"config":"value","secrets":"value"}
response = requests.request( \
    "PATCH", \
    "${BASE_URL}/api/merchants/string", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"config":"value","secrets":"value"}
with httpx.Client() as client:
    response = client.request( \
        "PATCH", \
        "${BASE_URL}/api/merchants/string", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"config":"value","secrets":"value"}`))

req, err := http.NewRequest("PATCH", "${BASE_URL}/api/merchants/string", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"config":"value","secrets":"value"}
uri = URI("${BASE_URL}/api/merchants/string")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"config":"value","secrets":"value"};
$client = new Client();
$response = $client->request("PATCH", "${BASE_URL}/api/merchants/string", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "${BASE_URL}/api/merchants/string");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"config\":\"value\",\"secrets\":\"value\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/merchants/{merchant_id}/products

List all products for a merchant. Each product can have multiple prices.

Responses

200application/json

schemaobject

dataarrayrequired

itemMerchantProductrequired

A product offered by a merchant. Products have prices with different intervals (monthly, yearly, etc.).

idstringrequired

Unique identifier for a merchant product.

merchant_idstringrequired

Unique identifier for a merchant.

product_keystring | nullrequired

external_product_idstring | nullrequired

upgrades_toarray | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

downgrades_toarray | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

404application/problem+jsonProblemDetails

Not Found

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/merchants/string/products" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/merchants/string/products";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/merchants/string/products";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/merchants/string/products",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/merchants/string/products",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/merchants/string/products", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/merchants/string/products", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/merchants/string/products", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/merchants/string/products", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/merchants/string/products")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/merchants/string/products", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/merchants/string/products");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/merchants/{merchant_id}/products

Create a new product for a merchant. Products have a unique product_key within the merchant.

Bodyapplication/json

product_keystringrequired

external_product_idstring

Responses

201application/json

Product created

schemaobject

dataMerchantProductrequired

A product offered by a merchant. Products have prices with different intervals (monthly, yearly, etc.).

idstringrequired

Unique identifier for a merchant product.

merchant_idstringrequired

Unique identifier for a merchant.

product_keystring | nullrequired

external_product_idstring | nullrequired

upgrades_toarray | nullrequired

itemstringrequired

downgrades_toarray | nullrequired

itemstringrequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

404application/problem+jsonProblemDetails

Not Found

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

409

Product key already exists

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/merchants/string/products" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"product_key":"string","external_product_id":"string"}'

const payload = {"product_key":"string","external_product_id":"string"};
const url = "${BASE_URL}/api/merchants/string/products";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"product_key":"string","external_product_id":"string"};
const url = "${BASE_URL}/api/merchants/string/products";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"product_key":"string","external_product_id":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/merchants/string/products",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"product_key":"string","external_product_id":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/merchants/string/products",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"product_key":"string","external_product_id":"string"};
const { body } = await request("${BASE_URL}/api/merchants/string/products", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"product_key":"string","external_product_id":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/merchants/string/products", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"product_key":"string","external_product_id":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/merchants/string/products", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"product_key":"string","external_product_id":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/merchants/string/products", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"product_key":"string","external_product_id":"string"}
uri = URI("${BASE_URL}/api/merchants/string/products")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"product_key":"string","external_product_id":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/merchants/string/products", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/merchants/string/products");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"product_key\":\"string\",\"external_product_id\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/merchants/{merchant_id}/products/{product_id}

Update a merchant product. Fields managed by Stripe sync are immutable for Stripe merchants.

Bodyapplication/json

product_keystring | null

external_product_idstring | null

upgrades_toarray | null

itemstringrequired

downgrades_toarray | null

itemstringrequired

Responses

200application/json

Product updated

schemaobject

dataMerchantProductrequired

A product offered by a merchant. Products have prices with different intervals (monthly, yearly, etc.).

idstringrequired

Unique identifier for a merchant product.

merchant_idstringrequired

Unique identifier for a merchant.

product_keystring | nullrequired

external_product_idstring | nullrequired

upgrades_toarray | nullrequired

itemstringrequired

downgrades_toarray | nullrequired

itemstringrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

404application/problem+jsonProblemDetails

Not Found

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

409

Conflict

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X PATCH \\
  "${BASE_URL}/api/merchants/mrc123/products/prd123" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '"value"'

const payload = "value";
const url = "${BASE_URL}/api/merchants/mrc123/products/prd123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = "value";
const url = "${BASE_URL}/api/merchants/mrc123/products/prd123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = "value";
const response = await axios({
  method: "patch",
  url: "${BASE_URL}/api/merchants/mrc123/products/prd123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = "value";
const response: AxiosResponse = await axios({
  method: "patch",
  url: "${BASE_URL}/api/merchants/mrc123/products/prd123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = "value";
const { body } = await request("${BASE_URL}/api/merchants/mrc123/products/prd123", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = "value"
response = requests.request( \
    "PATCH", \
    "${BASE_URL}/api/merchants/mrc123/products/prd123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = "value"
with httpx.Client() as client:
    response = client.request( \
        "PATCH", \
        "${BASE_URL}/api/merchants/mrc123/products/prd123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`"value"`))

req, err := http.NewRequest("PATCH", "${BASE_URL}/api/merchants/mrc123/products/prd123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = "value"
uri = URI("${BASE_URL}/api/merchants/mrc123/products/prd123")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = "value";
$client = new Client();
$response = $client->request("PATCH", "${BASE_URL}/api/merchants/mrc123/products/prd123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "${BASE_URL}/api/merchants/mrc123/products/prd123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("\"value\"", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/merchants/{merchant_id}/products/{product_id}/prices/{price_id}

Update a merchant price. Fields managed by Stripe sync are immutable for Stripe merchants.

Bodyapplication/json

price_keystring | null

external_price_idstring | null

interval

amount_centsnumber | null

currencystring | null

is_defaultboolean | null

Responses

200application/json

Price updated

schemaobject

dataMerchantPricerequired

A price for a merchant product. The external_price_id stores the provider's price identifier (e.g., Stripe's price_xxx).

idstringrequired

Unique identifier for a merchant price.

product_idstringrequired

Unique identifier for a merchant product.

price_keystring | nullrequired

external_price_idstring | nullrequired

intervalrequired

amount_centsnumberrequired

currencystringrequired

is_defaultbooleanrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

404application/problem+jsonProblemDetails

Not Found

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

409

Conflict

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X PATCH \\
  "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '"value"'

const payload = "value";
const url = "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = "value";
const url = "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = "value";
const response = await axios({
  method: "patch",
  url: "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = "value";
const response: AxiosResponse = await axios({
  method: "patch",
  url: "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = "value";
const { body } = await request("${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = "value"
response = requests.request( \
    "PATCH", \
    "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = "value"
with httpx.Client() as client:
    response = client.request( \
        "PATCH", \
        "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`"value"`))

req, err := http.NewRequest("PATCH", "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = "value"
uri = URI("${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = "value";
$client = new Client();
$response = $client->request("PATCH", "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("\"value\"", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/merchants/{merchant_id}/products/{product_id}/prices/{price_id}/features/{feature_id}

Update a merchant price feature template.

Bodyapplication/json

feature_keystring | null

value_textstring | null

value_intnumber | null

Responses

200application/json

Feature updated

schemaobject

dataPriceFeaturerequired

A feature template associated with a price. When a customer subscribes to this price, these features are copied to their billing record.

idstringrequired

Unique identifier for a price feature template.

price_idstringrequired

Unique identifier for a merchant price.

feature_keystringrequired

value_textstringrequired

value_intnumber | nullrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

404application/problem+jsonProblemDetails

Not Found

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

409

Conflict

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X PATCH \\
  "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123/features/prf123" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '"value"'

const payload = "value";
const url = "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123/features/prf123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = "value";
const url = "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123/features/prf123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = "value";
const response = await axios({
  method: "patch",
  url: "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123/features/prf123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = "value";
const response: AxiosResponse = await axios({
  method: "patch",
  url: "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123/features/prf123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = "value";
const { body } = await request("${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123/features/prf123", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = "value"
response = requests.request( \
    "PATCH", \
    "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123/features/prf123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = "value"
with httpx.Client() as client:
    response = client.request( \
        "PATCH", \
        "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123/features/prf123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`"value"`))

req, err := http.NewRequest("PATCH", "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123/features/prf123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = "value"
uri = URI("${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123/features/prf123")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = "value";
$client = new Client();
$response = $client->request("PATCH", "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123/features/prf123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "${BASE_URL}/api/merchants/mrc123/products/prd123/prices/prc123/features/prf123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("\"value\"", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/merchants/{merchant_id}/sync

Sync billing data from the merchant’s payment provider. Fetches all active subscriptions and updates local billing records.

Bodyapplication/json

bodyobjectrequired

An empty object that is reserved for future options. Fields will be optional.

Responses

200application/json

schemaobject

products_addedinteger

products_updatedinteger

products_deletedinteger

prices_addedinteger

prices_updatedinteger

prices_deletedinteger

subscriptions_updatedinteger

orphaned_subscription_idsarray

Stripe subscription IDs with no matching billing record

itemstringrequired

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

404application/problem+jsonProblemDetails

Not Found

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/merchants/string/sync" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const payload = {};
const url = "${BASE_URL}/api/merchants/string/sync";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {};
const url = "${BASE_URL}/api/merchants/string/sync";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/merchants/string/sync",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/merchants/string/sync",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {};
const { body } = await request("${BASE_URL}/api/merchants/string/sync", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/merchants/string/sync", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/merchants/string/sync", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/merchants/string/sync", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {}
uri = URI("${BASE_URL}/api/merchants/string/sync")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/merchants/string/sync", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/merchants/string/sync");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Merchant

idstringrequired

Unique identifier for a merchant.

application_idstringrequired

Unique identifier for an application.

providerrequired

configobjectrequired

Variant

Option 1object

providerrequired

publishable_keystring | nullrequired

connected_account_idstring | null

portal_configuration_idstring | nullrequired

Option 2object

providerrequired

organization_idstring | nullrequired

Option 3object

providerrequired

invoice_emailstring | nullrequired

payment_instructionsstring | nullrequired

Option 4object

providerrequired

profile_idstring | nullrequired

Option 5object

providerrequired

store_idstring | nullrequired

MerchantPrice

idstringrequired

Unique identifier for a merchant price.

product_idstringrequired

Unique identifier for a merchant product.

price_keystring | nullrequired

external_price_idstring | nullrequired

intervalrequired

amount_centsnumberrequired

currencystringrequired

is_defaultbooleanrequired

MerchantProduct

idstringrequired

Unique identifier for a merchant product.

merchant_idstringrequired

Unique identifier for a merchant.

product_keystring | nullrequired

external_product_idstring | nullrequired

upgrades_toarray | nullrequired

itemstringrequired

downgrades_toarray | nullrequired

itemstringrequired

PriceFeature

idstringrequired

Unique identifier for a price feature template.

price_idstringrequired

Unique identifier for a merchant price.

feature_keystringrequired

value_textstringrequired

value_intnumber | nullrequired

ProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

ValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

Features

แอปพลิเคชัน

Merchants

Contents

List Merchants

Create Merchant

Delete Merchant

Get Merchant

Update Merchant

List Merchant Products

Create Merchant Product

Update Merchant Product

Update Merchant Price

Update Merchant Price Feature

Sync Merchant Billing

Models

Features

Contents

Models

Related Features and Types

Features