Skip to content

Get an app store bundle

GET
/app-store/bundles/{bundleId}
curl --request GET \
--url https://qinto-api.blotout.io/app-store/bundles/2b7e4d10-8a3c-4f56-9e21-7c0d5b8f3a64 \
--header 'Authorization: Bearer <token>'

Returns one bundle a team can buy from the app store, with its price, trial, site limit, services, usage terms, the apps it holds right now and how its price compares with buying them separately.

How it works

not_found means no Live public bundle has this id, or the bundle cannot be sold right now.

Required permissions

  • None beyond a valid token; requires an OAuth token whose user belongs to a team
bundleId
required

Unique id (UUID) of the bundle, as the list operation returns it.

string format: uuid

Example

2b7e4d10-8a3c-4f56-9e21-7c0d5b8f3a64

Unique id (UUID) of the bundle, as the list operation returns it.

The bundle.

Media typeapplication/json
object
bundle
required

A bundle a team can buy: several apps on one line of its bill, for the sites it chooses.

object
bundleId
required

Unique id of the bundle.

string
name
required

Display name of the bundle.

string
description
required

One-line description of what a team gets. Null when not set.

string | null
longDescription
required

Longer description with its line breaks kept. Null when not set.

string | null
publisher
required

Display name of the organization that sells the bundle.

string
audience
required

public is offered in the app store; private is reached only through a bundle link.

string
Allowed values: public private
pricingModel
required

How the bundle charges: fixed is a base price, fixed_usage a base price and usage, usage only usage, and free nothing.

string
Allowed values: fixed fixed_usage usage free
basePriceCents
required

Base price per team, in US cents. Null when the model has none.

integer | null
billingInterval
required

How often the base price is billed. Null when the model has none.

string | null
Allowed values: monthly yearly one_time
trialDays
required

Length of the free trial in days. Null or 0 when there is none.

integer | null
siteLimit
required
Any of:

The number of sites a team can use the bundle on.

integer
extraSitePriceCents
required

Price of each site past the limit in US cents, billed like the base price. Null when extra sites aren’t sold.

integer | null
services
required

The services the bundle price covers.

Array<object>

A service the developer delivers, which the bundle price covers.

object
name
required

Name of the service. Empty only on a bundle that isn’t published yet.

string
detail
required

What the team gets. Empty when not set.

string
priceCents
required

What the service costs on its own, in US cents. Null only on a bundle that isn’t published yet.

integer | null
basis
required

How the price on its own is billed.

string
Allowed values: monthly one_time
usageCapCents
required

The most usage can add to a team’s bill each month, in US cents. Null when the model has no usage.

integer | null
meterTerms
required

The priced meters. Any other meter the apps report is free.

Array<object>

What one meter of one app costs on a bundle. A meter with no term is free.

object
appId
required

Id of the app that reports the meter.

string
key
required

Key of the meter in that app. The same key in two apps is two terms.

string
name
required

Name of the meter on the bundle.

string
unit
required

Plural unit, as the bill shows it. Empty only on a bundle that isn’t published yet.

string
includedAmount
required

Units included each month for the whole team, across its sites.

number
priceMicros
required

Price past the included amount, in US micro-dollars.

integer
perUnits
required

How many units that price covers. Null only on a bundle that isn’t published yet.

integer | null
apps
required

The apps the bundle holds right now, A–Z by name.

Array<object>

An app a bundle holds right now, with what it costs on its own.

object
appId
required

Unique id of the app.

string
slug
required

The app’s slug, to pass as appSlug to the app store app operations.

string
name
required

Display name of the app.

string
pricingModel
required

How the app charges on its own.

string
Allowed values: fixed fixed_usage usage free
basePriceCents
required

The app’s own monthly price per site in US cents; 0 when it has no base price.

integer
legal
required

The legal links a buyer accepts when buying the bundle.

object
termsUrl
required

The developer’s terms for the app.

string
privacyUrl
required

The developer’s privacy policy for the app.

string
comparison
required
One of:
object
kind
required

The pricing model has no base price to compare.

string
Allowed values: no_base_price

Example

{
"bundle": {
"bundleId": "2b7e4d10-8a3c-4f56-9e21-7c0d5b8f3a64",
"name": "Growth Stack",
"description": "Everything a store needs.",
"longDescription": "Who the bundle is for.",
"publisher": "Acme Dev",
"audience": "public",
"pricingModel": "fixed",
"basePriceCents": 2900,
"billingInterval": "monthly",
"trialDays": 14,
"siteLimit": 3,
"extraSitePriceCents": 500,
"services": [
{
"name": "Priority support",
"detail": "4-hour response, shared Slack channel",
"priceCents": 20000,
"basis": "monthly"
}
],
"usageCapCents": 10000,
"meterTerms": [
{
"appId": "7f3a1c92-4b6d-4e8a-b1d3-5c9e2f7a6b10",
"key": "events",
"name": "Events",
"unit": "events",
"includedAmount": 100000,
"priceMicros": 500000,
"perUnits": 1000
}
],
"apps": [
{
"appId": "7f3a1c92-4b6d-4e8a-b1d3-5c9e2f7a6b10",
"slug": "facebook-capi",
"name": "Facebook CAPI",
"pricingModel": "fixed",
"basePriceCents": 1900,
"legal": {
"termsUrl": "https://acme.example/terms",
"privacyUrl": "https://acme.example/privacy"
}
}
],
"comparison": {
"kind": "fixed_sites",
"sites": 3,
"months": 1,
"appsCents": 5700,
"servicesCents": 0,
"separatelyCents": 5700,
"savingCents": 2800,
"savingPercent": 49,
"oneTimeServicesCents": 50000
}
}
}

invalid_params — A path parameter failed validation (for example a malformed UUID); details pinpoints the offending parameter.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: invalid_params
details

Field-level validation errors: a tree keyed by input property, each node carrying an errors array of human-readable messages. Render it to help the caller correct the request.

object
key
additional properties

Example

{
"error": "invalid_params",
"details": {
"errors": [],
"properties": {
"teamId": {
"errors": [
"Invalid UUID"
]
}
}
}
}

unauthenticated — The Authorization: Bearer token is missing, malformed, or no longer valid. Generate a team API token or obtain a new OAuth access token.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: unauthenticated

Example

{
"error": "unauthenticated"
}

forbidden — The bearer credential lacks the required permission or belongs to another team, or its user lacks the organization role a developer operation needs. Update its policies, use a credential bound to the addressed team, or ask an organization owner for the role; message states the reason when one is known.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: forbidden
message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string

Example

{
"error": "forbidden",
"message": "The Cloudflare API token is invalid or expired."
}

not_found — The addressed resource does not exist within this team; check the id and retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: not_found

Example

{
"error": "not_found"
}

internal — Unexpected server error. Nothing is guaranteed to have been persisted; idempotent operations are safe to retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: internal

Example

{
"error": "internal"
}