User Subscriptions (API) | Accountmaker 文档

User-controlled subscription endpoints under /auth/subscriptions* (B2C, account-context authorization)

GET/auth/subscriptions

List all subscription records for the account in the current access token. Shows subscription status, features, and payment info. More

Responses

200application/json

schemaobject

dataarrayrequired

itemAccountSubscriptionrequired

A subscription for an account. Contains a snapshot of the subscription and naturally expiring timestamps.

idstringrequired

Unique identifier for an account subscription.

account_idstringrequired

Unique identifier for an account.

providerrequired

external_idstringrequired

external_datarequired

paid_untilstringrequired

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}/auth/subscriptions" \\
  -H "Authorization: Bearer ${API_TOKEN}"

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

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

const url = "${BASE_URL}/auth/subscriptions";
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}/auth/subscriptions",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

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

console.log(response.data);

import { request } from "undici";

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

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

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/auth/subscriptions", \
    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}/auth/subscriptions", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/auth/subscriptions", 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}/auth/subscriptions")
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}/auth/subscriptions", [
  '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}/auth/subscriptions");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/auth/subscriptions/{subscription_id}/cancel

Cancel the subscription on the account in the current access token.

By default, cancellation takes effect at the end of the current subscription period. Use timing: "immediate" for immediate cancellation.

Optionally provide a reason and feedback for analytics.

Body application/json

timing

reasonstring

feedback

Responses

204

Subscription canceled

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 POST \\
  "${BASE_URL}/auth/subscriptions/sub123/cancel" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"timing":"immediate","reason":"string","feedback":"customer_service"}'

const payload = {"timing":"immediate","reason":"string","feedback":"customer_service"};
const url = "${BASE_URL}/auth/subscriptions/sub123/cancel";
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 = {"timing":"immediate","reason":"string","feedback":"customer_service"};
const url = "${BASE_URL}/auth/subscriptions/sub123/cancel";
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 = {"timing":"immediate","reason":"string","feedback":"customer_service"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/auth/subscriptions/sub123/cancel",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"timing":"immediate","reason":"string","feedback":"customer_service"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/auth/subscriptions/sub123/cancel",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"timing":"immediate","reason":"string","feedback":"customer_service"};
const { body } = await request("${BASE_URL}/auth/subscriptions/sub123/cancel", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

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

import requests

payload = {"timing":"immediate","reason":"string","feedback":"customer_service"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/auth/subscriptions/sub123/cancel", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"timing":"immediate","reason":"string","feedback":"customer_service"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/auth/subscriptions/sub123/cancel", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"timing":"immediate","reason":"string","feedback":"customer_service"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/auth/subscriptions/sub123/cancel", 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 = {"timing":"immediate","reason":"string","feedback":"customer_service"}
uri = URI("${BASE_URL}/auth/subscriptions/sub123/cancel")
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 = {"timing":"immediate","reason":"string","feedback":"customer_service"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/auth/subscriptions/sub123/cancel", [
  '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}/auth/subscriptions/sub123/cancel");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"timing\":\"immediate\",\"reason\":\"string\",\"feedback\":\"customer_service\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/auth/subscriptions/{subscription_id}/change

Change the subscription plan, interval, or currency for the account in the current access token.

To change products, the target must be in the current product’s upgrades_to or downgrades_to list. To change interval or currency without switching products, omit product_key.

Upgrades are invoiced immediately with proration. Downgrades and lateral changes (interval/currency only) take effect at the next cycle.

Body application/json

product_keystring

interval

currencystring

Responses

204

Subscription changed

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 POST \\
  "${BASE_URL}/auth/subscriptions/sub123/change" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"product_key":"string","interval":"month","currency":"string"}'

const payload = {"product_key":"string","interval":"month","currency":"string"};
const url = "${BASE_URL}/auth/subscriptions/sub123/change";
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","interval":"month","currency":"string"};
const url = "${BASE_URL}/auth/subscriptions/sub123/change";
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","interval":"month","currency":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/auth/subscriptions/sub123/change",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"product_key":"string","interval":"month","currency":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/auth/subscriptions/sub123/change",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"product_key":"string","interval":"month","currency":"string"};
const { body } = await request("${BASE_URL}/auth/subscriptions/sub123/change", {
  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","interval":"month","currency":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/auth/subscriptions/sub123/change", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"product_key":"string","interval":"month","currency":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/auth/subscriptions/sub123/change", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

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

req, err := http.NewRequest("POST", "${BASE_URL}/auth/subscriptions/sub123/change", 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","interval":"month","currency":"string"}
uri = URI("${BASE_URL}/auth/subscriptions/sub123/change")
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","interval":"month","currency":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/auth/subscriptions/sub123/change", [
  '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}/auth/subscriptions/sub123/change");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"product_key\":\"string\",\"interval\":\"month\",\"currency\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/auth/subscriptions/features

List all active features granted to the account in the current access token. Returns features from active subscriptions and permanent grants. More

Responses

200application/json

schemaobject

dataarrayrequired

itemSubscriptionFeaturerequired

A feature granted to an account via a subscription. When subscription_id is null, the feature is always active (free tier or manual grants). When subscription_id is set, the feature is active only while the subscription's paid_until > NOW().

idstringrequired

Unique identifier for a subscription feature.

subscription_idstring | nullrequired

Unique identifier for an account subscription.

feature_keystringrequired

value_textstringrequired

value_intnumber | nullrequired

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}/auth/subscriptions/features" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/auth/subscriptions/features";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

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

const url = "${BASE_URL}/auth/subscriptions/features";
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}/auth/subscriptions/features",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

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

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/auth/subscriptions/features", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

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

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/auth/subscriptions/features", \
    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}/auth/subscriptions/features", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/auth/subscriptions/features", 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}/auth/subscriptions/features")
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}/auth/subscriptions/features", [
  '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}/auth/subscriptions/features");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/auth/subscriptions/identity

Get the Stripe customer identity for the account in the current access token.

Returns the external customer ID used for payment processing.

Responses

200application/json

Subscription identity found

schemaobject

dataobjectrequired

providerstringrequired

external_customer_idstringrequired

created_atstring · date-timerequired

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

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/auth/subscriptions/identity" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/auth/subscriptions/identity";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

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

const url = "${BASE_URL}/auth/subscriptions/identity";
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}/auth/subscriptions/identity",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

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

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/auth/subscriptions/identity", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

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

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/auth/subscriptions/identity", \
    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}/auth/subscriptions/identity", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/auth/subscriptions/identity", 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}/auth/subscriptions/identity")
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}/auth/subscriptions/identity", [
  '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}/auth/subscriptions/identity");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/auth/subscriptions/merchants

List merchants available for subscriptions on the account in the current access token.

Returns merchants with products, prices, and features.

Responses

200application/json

schemaobject

dataarrayrequired

itemobjectrequired

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.

productsarrayrequired

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}/auth/subscriptions/merchants" \\
  -H "Authorization: Bearer ${API_TOKEN}"

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

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

const url = "${BASE_URL}/auth/subscriptions/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}/auth/subscriptions/merchants",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

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

console.log(response.data);

import { request } from "undici";

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

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

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/auth/subscriptions/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}/auth/subscriptions/merchants", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/auth/subscriptions/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}/auth/subscriptions/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}/auth/subscriptions/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}/auth/subscriptions/merchants");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/auth/subscriptions/stripe/checkout-session

Create a Stripe Checkout session for subscription signup or plan changes.

Returns a URL to redirect the user to Stripe’s hosted checkout page. After successful payment, the user is redirected to success_url. If cancelled, the user is redirected to cancel_url.

Body application/json

price_idstringrequired

Unique identifier for a merchant price.

merchant_idstring

Unique identifier for a merchant.

success_urlstring · urirequired

cancel_urlstring · urirequired

Responses

200application/json

Checkout session created

schemaobject

urlstringrequired

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 POST \\
  "${BASE_URL}/auth/subscriptions/stripe/checkout-session" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"price_id":"prc123","merchant_id":"mrc123","success_url":"string","cancel_url":"string"}'

const payload = {"price_id":"prc123","merchant_id":"mrc123","success_url":"string","cancel_url":"string"};
const url = "${BASE_URL}/auth/subscriptions/stripe/checkout-session";
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 = {"price_id":"prc123","merchant_id":"mrc123","success_url":"string","cancel_url":"string"};
const url = "${BASE_URL}/auth/subscriptions/stripe/checkout-session";
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 = {"price_id":"prc123","merchant_id":"mrc123","success_url":"string","cancel_url":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/auth/subscriptions/stripe/checkout-session",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"price_id":"prc123","merchant_id":"mrc123","success_url":"string","cancel_url":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/auth/subscriptions/stripe/checkout-session",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"price_id":"prc123","merchant_id":"mrc123","success_url":"string","cancel_url":"string"};
const { body } = await request("${BASE_URL}/auth/subscriptions/stripe/checkout-session", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

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

import requests

payload = {"price_id":"prc123","merchant_id":"mrc123","success_url":"string","cancel_url":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/auth/subscriptions/stripe/checkout-session", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"price_id":"prc123","merchant_id":"mrc123","success_url":"string","cancel_url":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/auth/subscriptions/stripe/checkout-session", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"price_id":"prc123","merchant_id":"mrc123","success_url":"string","cancel_url":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/auth/subscriptions/stripe/checkout-session", 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 = {"price_id":"prc123","merchant_id":"mrc123","success_url":"string","cancel_url":"string"}
uri = URI("${BASE_URL}/auth/subscriptions/stripe/checkout-session")
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 = {"price_id":"prc123","merchant_id":"mrc123","success_url":"string","cancel_url":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/auth/subscriptions/stripe/checkout-session", [
  '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}/auth/subscriptions/stripe/checkout-session");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"price_id\":\"prc123\",\"merchant_id\":\"mrc123\",\"success_url\":\"string\",\"cancel_url\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/auth/subscriptions/stripe/checkout-session-sync

Sync subscription records from Stripe after checkout completion.

Call this endpoint when the user returns from Stripe checkout to immediately sync their subscription status. This avoids waiting for webhooks to arrive.

The session_id is the Stripe checkout session ID from the success URL.

Body application/json

session_idstringrequired

merchant_idstring

Unique identifier for a merchant.

Responses

200application/json

Synced subscription

schemaobject

dataAccountSubscriptionrequired

A subscription for an account. Contains a snapshot of the subscription and naturally expiring timestamps.

idstringrequired

Unique identifier for an account subscription.

account_idstringrequired

Unique identifier for an account.

providerrequired

external_idstringrequired

external_datarequired

paid_untilstringrequired

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

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/auth/subscriptions/stripe/checkout-session-sync" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"session_id":"string","merchant_id":"mrc123"}'

const payload = {"session_id":"string","merchant_id":"mrc123"};
const url = "${BASE_URL}/auth/subscriptions/stripe/checkout-session-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 = {"session_id":"string","merchant_id":"mrc123"};
const url = "${BASE_URL}/auth/subscriptions/stripe/checkout-session-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 = {"session_id":"string","merchant_id":"mrc123"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/auth/subscriptions/stripe/checkout-session-sync",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"session_id":"string","merchant_id":"mrc123"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/auth/subscriptions/stripe/checkout-session-sync",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"session_id":"string","merchant_id":"mrc123"};
const { body } = await request("${BASE_URL}/auth/subscriptions/stripe/checkout-session-sync", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

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

import requests

payload = {"session_id":"string","merchant_id":"mrc123"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/auth/subscriptions/stripe/checkout-session-sync", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"session_id":"string","merchant_id":"mrc123"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/auth/subscriptions/stripe/checkout-session-sync", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"session_id":"string","merchant_id":"mrc123"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/auth/subscriptions/stripe/checkout-session-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 = {"session_id":"string","merchant_id":"mrc123"}
uri = URI("${BASE_URL}/auth/subscriptions/stripe/checkout-session-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 = {"session_id":"string","merchant_id":"mrc123"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/auth/subscriptions/stripe/checkout-session-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}/auth/subscriptions/stripe/checkout-session-sync");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"session_id\":\"string\",\"merchant_id\":\"mrc123\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/auth/subscriptions/stripe/portal-session

Create a Stripe Customer Portal session for managing subscriptions.

Returns a URL to redirect the user to Stripe’s hosted customer portal where they can manage their subscription, payment methods, and invoices.

After the user is done, they are redirected to return_url.

Requires: Account must have an existing Stripe subscription identity.

Body application/json

return_urlstring · urirequired

localestring

flow_dataobject

typerequired

subscription_cancelobject

subscriptionstringrequired

subscription_updateobject

subscriptionstringrequired

subscription_update_confirmobject

subscriptionstringrequired

itemsarrayrequired

itemobjectrequired

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

after_completionobject

typerequired

redirectobject

return_urlstring · urirequired

Responses

200application/json

Portal session created

schemaobject

urlstringrequired

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 POST \\
  "${BASE_URL}/auth/subscriptions/stripe/portal-session" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"return_url":"string","locale":"string","flow_data":{"type":"payment_method_update","subscription_cancel":{"subscription":"string"},"subscription_update":{"subscription":"string"},"subscription_update_confirm":{"subscription":"string","items":[{"id":"string","price":"string","quantity":123}]},"after_completion":{"type":"hosted_confirmation","redirect":{"return_url":"string"}}}}'

const payload = {"return_url":"string","locale":"string","flow_data":{"type":"payment_method_update","subscription_cancel":{"subscription":"string"},"subscription_update":{"subscription":"string"},"subscription_update_confirm":{"subscription":"string","items":[{"id":"string","price":"string","quantity":123}]},"after_completion":{"type":"hosted_confirmation","redirect":{"return_url":"string"}}}};
const url = "${BASE_URL}/auth/subscriptions/stripe/portal-session";
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 = {"return_url":"string","locale":"string","flow_data":{"type":"payment_method_update","subscription_cancel":{"subscription":"string"},"subscription_update":{"subscription":"string"},"subscription_update_confirm":{"subscription":"string","items":[{"id":"string","price":"string","quantity":123}]},"after_completion":{"type":"hosted_confirmation","redirect":{"return_url":"string"}}}};
const url = "${BASE_URL}/auth/subscriptions/stripe/portal-session";
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 = {"return_url":"string","locale":"string","flow_data":{"type":"payment_method_update","subscription_cancel":{"subscription":"string"},"subscription_update":{"subscription":"string"},"subscription_update_confirm":{"subscription":"string","items":[{"id":"string","price":"string","quantity":123}]},"after_completion":{"type":"hosted_confirmation","redirect":{"return_url":"string"}}}};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/auth/subscriptions/stripe/portal-session",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"return_url":"string","locale":"string","flow_data":{"type":"payment_method_update","subscription_cancel":{"subscription":"string"},"subscription_update":{"subscription":"string"},"subscription_update_confirm":{"subscription":"string","items":[{"id":"string","price":"string","quantity":123}]},"after_completion":{"type":"hosted_confirmation","redirect":{"return_url":"string"}}}};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/auth/subscriptions/stripe/portal-session",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"return_url":"string","locale":"string","flow_data":{"type":"payment_method_update","subscription_cancel":{"subscription":"string"},"subscription_update":{"subscription":"string"},"subscription_update_confirm":{"subscription":"string","items":[{"id":"string","price":"string","quantity":123}]},"after_completion":{"type":"hosted_confirmation","redirect":{"return_url":"string"}}}};
const { body } = await request("${BASE_URL}/auth/subscriptions/stripe/portal-session", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

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

import requests

payload = {"return_url":"string","locale":"string","flow_data":{"type":"payment_method_update","subscription_cancel":{"subscription":"string"},"subscription_update":{"subscription":"string"},"subscription_update_confirm":{"subscription":"string","items":[{"id":"string","price":"string","quantity":123}]},"after_completion":{"type":"hosted_confirmation","redirect":{"return_url":"string"}}}}
response = requests.request( \
    "POST", \
    "${BASE_URL}/auth/subscriptions/stripe/portal-session", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"return_url":"string","locale":"string","flow_data":{"type":"payment_method_update","subscription_cancel":{"subscription":"string"},"subscription_update":{"subscription":"string"},"subscription_update_confirm":{"subscription":"string","items":[{"id":"string","price":"string","quantity":123}]},"after_completion":{"type":"hosted_confirmation","redirect":{"return_url":"string"}}}}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/auth/subscriptions/stripe/portal-session", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"return_url":"string","locale":"string","flow_data":{"type":"payment_method_update","subscription_cancel":{"subscription":"string"},"subscription_update":{"subscription":"string"},"subscription_update_confirm":{"subscription":"string","items":[{"id":"string","price":"string","quantity":123}]},"after_completion":{"type":"hosted_confirmation","redirect":{"return_url":"string"}}}}`))

req, err := http.NewRequest("POST", "${BASE_URL}/auth/subscriptions/stripe/portal-session", 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 = {"return_url":"string","locale":"string","flow_data":{"type":"payment_method_update","subscription_cancel":{"subscription":"string"},"subscription_update":{"subscription":"string"},"subscription_update_confirm":{"subscription":"string","items":[{"id":"string","price":"string","quantity":123}]},"after_completion":{"type":"hosted_confirmation","redirect":{"return_url":"string"}}}}
uri = URI("${BASE_URL}/auth/subscriptions/stripe/portal-session")
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 = {"return_url":"string","locale":"string","flow_data":{"type":"payment_method_update","subscription_cancel":{"subscription":"string"},"subscription_update":{"subscription":"string"},"subscription_update_confirm":{"subscription":"string","items":[{"id":"string","price":"string","quantity":123}]},"after_completion":{"type":"hosted_confirmation","redirect":{"return_url":"string"}}}};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/auth/subscriptions/stripe/portal-session", [
  '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}/auth/subscriptions/stripe/portal-session");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"return_url\":\"string\",\"locale\":\"string\",\"flow_data\":{\"type\":\"payment_method_update\",\"subscription_cancel\":{\"subscription\":\"string\"},\"subscription_update\":{\"subscription\":\"string\"},\"subscription_update_confirm\":{\"subscription\":\"string\",\"items\":[{\"id\":\"string\",\"price\":\"string\",\"quantity\":123}]},\"after_completion\":{\"type\":\"hosted_confirmation\",\"redirect\":{\"return_url\":\"string\"}}}}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/auth/subscriptions/sync

Sync all subscription records for the account in the current access token.

This endpoint fetches all subscriptions for the account’s Stripe customer and syncs them to the database.

Body application/json

bodyobjectrequired

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

Responses

200application/json

Sync result with subscription data

schemaobject

dataarrayrequired

itemAccountSubscriptionrequired

A subscription for an account. Contains a snapshot of the subscription and naturally expiring timestamps.

idstringrequired

Unique identifier for an account subscription.

account_idstringrequired

Unique identifier for an account.

providerrequired

external_idstringrequired

external_datarequired

paid_untilstringrequired

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 POST \\
  "${BASE_URL}/auth/subscriptions/sync?allow_deletes=true" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const payload = {};
const url = "${BASE_URL}/auth/subscriptions/sync?allow_deletes=true";
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}/auth/subscriptions/sync?allow_deletes=true";
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}/auth/subscriptions/sync?allow_deletes=true",
  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}/auth/subscriptions/sync?allow_deletes=true",
  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}/auth/subscriptions/sync?allow_deletes=true", {
  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}/auth/subscriptions/sync?allow_deletes=true", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/auth/subscriptions/sync?allow_deletes=true", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

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

req, err := http.NewRequest("POST", "${BASE_URL}/auth/subscriptions/sync?allow_deletes=true", 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}/auth/subscriptions/sync?allow_deletes=true")
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}/auth/subscriptions/sync?allow_deletes=true", [
  '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}/auth/subscriptions/sync?allow_deletes=true");
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());

AccountSubscription

idstringrequired

Unique identifier for an account subscription.

account_idstringrequired

Unique identifier for an account.

providerrequired

external_idstringrequired

external_datarequired

paid_untilstringrequired

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

SubscriptionFeature

idstringrequired

Unique identifier for a subscription feature.

subscription_idstring | nullrequired

Unique identifier for an account subscription.

feature_keystringrequired

value_textstringrequired

value_intnumber | nullrequired

ValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

User Subscriptions

Contents

List Account Subscriptions

Cancel Subscription

Change Subscription

List Account Subscription Features

Get Subscription Identity

List Subscription Merchants

Create Stripe Checkout Session

Sync Subscription from Stripe Checkout Session

Create Stripe Customer Portal Session

Sync All Subscriptions from Stripe

Models

Features

Types

Contents

Models

Related Features and Types

Features

Types