Billing

Subscriptions and the Stripe checkout.11 operations

Headers on every response

Every response on this page carries these headers.
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).

Operations

GET/api/v1/plansNo session needed

List the plans with their names, prices and credits

Public: what the landing page and /priser show, read from the same rows the admin edits and checkout uses, fewest credits first. Says nothing about any household. Cached for five minutes (Cache-Control: public, max-age=300), so a price changed in the admin reaches the pages within that. country (ISO 3166-1 alpha-2, optional) prices the plans for that country: its currency and its list price, the same as in the app stores (ADR-674 (#5142)); priceSet is false for a paid plan not priced there yet. No country, or one Bryti does not sell in, is Norway's prices.

Parameters

NameInTypeRequiredDescription
countryquerystring——

Responses

200OK
application/jsonPublicPlanResponse[]
400The request could not be read as the route needs it: a body that is not the documented shape (a required field left out, a null where none is allowed, a value too long for its field), a parameter that does not parse, or a NUL character anywhere (#3540, #3541, #3543). Code validation_failed or value_too_long.
application/problem+jsonProblemDetails
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503The server is down for maintenance (#4693). Retry-After says when to try again; problem type maintenance. Every call under /api answers this while maintenance mode is on, the version floor included.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl \
  "https://bryti.app/api/v1/plans"

Example response

200application/json
[
  {
    "code": "string",
    "name": "string",
    "priceMonthMinor": 0,
    "priceCurrency": "string",
    "monthlyCredits": 0,
    "welcomeCredits": 0,
    "purchasable": false,
    "priceSet": true
  }
]
POST/api/v1/billing/appstore/notificationsNo session needed

Receive an App Store Server Notification

Not for the apps: public and unauthenticated, called by Apple with App Store Server Notifications V2. The signed payload is verified against Apple's root certificate (the x5c chain to Apple Root CA G3, ES256) and the app's bundle id; a bad one is a 400 (code billing_webhook_rejected). Applies subscriptions bought, renewed, changed, failing, expired and refunded, and credit packs bought and refunded. Safe to replay: the same notification twice changes nothing the second time, and an older state arriving after a newer one is ignored. 503 (code billing_disabled) when the App Store is not switched on here.

Parameters

No parameters

Responses

200OK
400Bad Request
application/problem+jsonProblemDetails
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503Service Unavailable
application/problem+jsonProblemDetails

Example

curl \
  -X POST \
  "https://bryti.app/api/v1/billing/appstore/notifications"
POST/api/v1/billing/play/notificationsNo session needed

Receive a Google Play real-time developer notification

Not for the apps: public and unauthenticated, called by Google Cloud Pub/Sub's authenticated push with a Play real-time developer notification. The Bearer token is verified as Google's OIDC token for this URL and the push service account, and the package name must be the app's; a bad one is a 400 (code billing_webhook_rejected). Every subscription notification is answered by asking Play for the subscription's state, so what is applied is Play's own word. Applies subscriptions and credit packs bought, renewed, changed, on hold, expired, revoked and refunded. Safe to replay. 503 (code billing_disabled) when Play is not switched on here.

Parameters

No parameters

Responses

200OK
400Bad Request
application/problem+jsonProblemDetails
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503Service Unavailable
application/problem+jsonProblemDetails

Example

curl \
  -X POST \
  "https://bryti.app/api/v1/billing/play/notifications"
POST/api/v1/billing/webhookNo session needed

Receive a billing event from Stripe

Not for the apps: public and unauthenticated, verified by the Stripe-Signature header over the raw body (#603); a bad signature is a 400 (code billing_webhook_rejected). Applies checkout completed, subscription changed or deleted, and payment failed. Safe to replay: the same event twice converges on the same state.

Parameters

No parameters

Responses

200OK
400Bad Request
application/problem+jsonProblemDetails
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503The server is down for maintenance (#4693). Retry-After says when to try again; problem type maintenance. Every call under /api answers this while maintenance mode is on, the version floor included.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl \
  -X POST \
  "https://bryti.app/api/v1/billing/webhook"
GET/api/v1/households/{householdId}/billing

Read the household's plan, billing status and the plans it could buy

Any member. PaymentsEnabled is false when no provider keys are configured — the apps then hide the upgrade buttons. CanManage means a provider-side customer exists to open the portal for.

Parameters

NameInTypeRequiredDescription
householdIdpathstring (uuid)Required—

Responses

200OK
application/jsonBillingStatusResponse
401No session, or the session is no longer valid.
application/problem+jsonProblemDetails
404Not Found
application/problem+jsonProblemDetails
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503The server is down for maintenance (#4693). Retry-After says when to try again; problem type maintenance. Every call under /api answers this while maintenance mode is on, the version floor included.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Example

curl -b "bryti_session=…" \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/billing"

Example response

200application/json
{
  "paymentsEnabled": false,
  "planCode": "string",
  "planName": "string",
  "pendingPlanCode": "string",
  "status": "string",
  "canManage": false,
  "plans": [
    {
      "code": "string",
      "name": "string",
      "priceMonthMinor": 0,
      "priceCurrency": "string",
      "monthlyCredits": 0,
      "purchasable": false,
      "current": false,
      "pending": false,
      "priceSet": true
    }
  ],
  "channel": "None"
}
POST/api/v1/households/{householdId}/billing/checkout

Start a hosted checkout for a plan and get the URL to send the caller to

Adults only; a Junior member gets 403. ReturnUrl must be an absolute http(s) URL; the provider sends the caller back to it with ?checkout=success or ?checkout=cancelled. 400 (code start_now_required) unless StartNow is true — the member ticked «start now», so a withdrawal within the 14 days pays for the days used (#3737); the yes is stored with the subscription when the checkout completes. 400 for an unknown plan or a plan that cannot be bought online. 409 (code already_subscribed) when the household already has a paid subscription — refetch the billing status and change plan from the portal instead (#3577). 503 (code billing_disabled) when online payments are switched off in this environment (ADR-026). 403 (code email_not_confirmed) when the caller's own e-mail address has not been confirmed — the receipts go there (ADR-290). 403 (code country_not_supported) when the household's country is not one where Bryti takes payments yet; the billing status then says paymentsEnabled false and no plan is purchasable (#4993). Outside Norway the session charges the household's own currency at the country's list price (ADR-677 (#5151)): 409 (code price_not_set_for_country) when that price is not set, or the Stripe price holds no currency option at that amount.

Parameters

NameInTypeRequiredDescription
householdIdpathstring (uuid)Required—

Request body

application/jsonRequiredStartCheckoutRequest

Responses

200OK
application/jsonRedirectResponse
400Bad Request
application/problem+jsonProblemDetails
401No session, or the session is no longer valid.
application/problem+jsonProblemDetails
403Forbidden
application/problem+jsonProblemDetails
409Conflict
application/problem+jsonProblemDetails
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503Service Unavailable
application/problem+jsonProblemDetails

Problem codes

The `code` in the problem body is what to branch on. `detail` is English, written for a log.

email_not_confirmed
— Confirm your email before you pay.
price_not_set_for_country
— Paid plans aren’t available in your country yet.
start_now_required

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/billing/checkout" \
  -H "Content-Type: application/json" \
  -d '{"planCode":"string","returnUrl":"string","startNow":false}'

Example response

200application/json
{
  "url": "string"
}
POST/api/v1/households/{householdId}/billing/preview

Preview what changing to a plan would charge now, give now and charge next

Adults only; a Junior member gets 403. Nothing is charged or changed. A bigger plan applies now and pays the difference for the days left of the period (ADR-392 (#3342)): the amount comes from Stripe's preview of the upcoming invoice when the household pays through Stripe, otherwise from the same proration done here with Estimated set. A smaller plan pays nothing now and applies from the next period. From the free plan the full month is paid now. 400 for an unknown plan or one that cannot be bought online; 503 (code billing_disabled) when online payments are switched off. Amounts are in the household's own currency at the country's list price (ADR-677 (#5151)); 409 (code price_not_set_for_country) when the plan has no price there yet.

Parameters

NameInTypeRequiredDescription
householdIdpathstring (uuid)Required—

Request body

application/jsonRequiredBillingPreviewRequest

Responses

200OK
application/jsonBillingPreviewResponse
400Bad Request
application/problem+jsonProblemDetails
401No session, or the session is no longer valid.
application/problem+jsonProblemDetails
403Forbidden
application/problem+jsonProblemDetails
404Not Found
application/problem+jsonProblemDetails
409Conflict
application/problem+jsonProblemDetails
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503Service Unavailable
application/problem+jsonProblemDetails

Problem codes

The `code` in the problem body is what to branch on. `detail` is English, written for a log.

price_not_set_for_country
— Paid plans aren’t available in your country yet.

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/billing/preview" \
  -H "Content-Type: application/json" \
  -d '{"planCode":"string"}'

Example response

200application/json
{
  "currentPlanCode": "string",
  "planCode": "string",
  "kind": "NewSubscription",
  "dueNowMinor": 0,
  "currency": "string",
  "daysLeft": 0,
  "periodDays": 0,
  "creditsNow": 0,
  "creditsUsed": 0,
  "creditsLeftAfter": 0,
  "nextPaymentAt": "2026-09-07T16:30:00Z",
  "nextPaymentMinor": 0,
  "appliesAt": "2026-09-07T16:30:00Z",
  "estimated": false,
  "canManage": false
}
POST/api/v1/households/{householdId}/billing/portal

Open the provider's billing portal and get the URL to send the caller to

Adults only; a Junior member gets 403. For managing or cancelling the subscription. 400 when the household has not paid online yet; 503 (code billing_disabled) when online payments are switched off.

Parameters

NameInTypeRequiredDescription
householdIdpathstring (uuid)Required—

Request body

application/jsonRequiredOpenPortalRequest

Responses

200OK
application/jsonRedirectResponse
400Bad Request
application/problem+jsonProblemDetails
401No session, or the session is no longer valid.
application/problem+jsonProblemDetails
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503Service Unavailable
application/problem+jsonProblemDetails

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/billing/portal" \
  -H "Content-Type: application/json" \
  -d '{"returnUrl":"string"}'

Example response

200application/json
{
  "url": "string"
}
POST/api/v1/households/{householdId}/billing/store/intent

Get the household's store token before buying a plan or credit pack in the app

Adults only; a Junior member gets 403. Called right before the App Store's or Google Play's purchase sheet opens. Answers the household's store token: pass AccountToken as appAccountToken on iOS and ObfuscatedAccountId as obfuscatedAccountId on Android, so the signed transaction names the household. One token per household, stable across purchases. 400 for a product id that is no plan or active pack on that store. 409 (code already_subscribed) for a plan when the household already pays through Stripe or the other store — one paid plan per household, changed where it was bought. 403 (code country_not_supported) when payments are not open in the household's country. 503 (code billing_disabled) when that store is not switched on here.

Parameters

NameInTypeRequiredDescription
householdIdpathstring (uuid)Required—

Request body

application/jsonRequiredStoreIntentRequest

Responses

200OK
application/jsonStoreIntentResponse
400Bad Request
application/problem+jsonProblemDetails
401No session, or the session is no longer valid.
application/problem+jsonProblemDetails
403Forbidden
application/problem+jsonProblemDetails
409Conflict
application/problem+jsonProblemDetails
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503Service Unavailable
application/problem+jsonProblemDetails

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/billing/store/intent" \
  -H "Content-Type: application/json" \
  -d '{"channel":"AppStore","productId":"string"}'

Example response

200application/json
{
  "accountToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "obfuscatedAccountId": "string",
  "productId": "string"
}
POST/api/v1/households/{householdId}/billing/store/verify

Confirm a purchase made in the App Store or Google Play and apply it

Adults only; a Junior member gets 403. Send the App Store's signed transaction (SignedTransaction, its jwsRepresentation) or Play's PurchaseToken with the ProductId. Bryti verifies it with the store, applies it — a plan with more credits applies now, fewer from the next period; a credit pack adds its credits, which carry over — and answers the billing status as it is after. Finish the transaction on the phone only after this answers 200. Safe to repeat for the same purchase (a restore sends every one again): it is applied once. 400 (code store_purchase_invalid) when the proof does not verify, names another product, or names no household. 409 (code store_purchase_elsewhere) when the purchase belongs to another household. 409 (code already_subscribed) when the household already paid for its plan through Stripe or the other store; the first plan is kept. 403 (code store_sandbox_not_allowed) when the purchase was made in the App Store sandbox (TestFlight, App Review) or by a Play licence tester and the platform admin has not allowed test purchases for this household; nothing is applied, so leave the transaction unfinished. 503 (code billing_disabled) when that store is not switched on here.

Parameters

NameInTypeRequiredDescription
householdIdpathstring (uuid)Required—

Request body

application/jsonRequiredStoreVerifyRequest

Responses

200OK
application/jsonBillingStatusResponse
400Bad Request
application/problem+jsonProblemDetails
401No session, or the session is no longer valid.
application/problem+jsonProblemDetails
403Forbidden
application/problem+jsonProblemDetails
404Not Found
application/problem+jsonProblemDetails
409Conflict
application/problem+jsonProblemDetails
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503Service Unavailable
application/problem+jsonProblemDetails

Problem codes

The `code` in the problem body is what to branch on. `detail` is English, written for a log.

store_purchase_elsewhere
— This plan was bought for another household. Switch to that household to use it.
store_purchase_invalid
— Your purchase was not confirmed by the store. If you have been charged, contact the store to request a refund.
store_sandbox_not_allowed
— Only approved households can make test purchases.

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/billing/store/verify" \
  -H "Content-Type: application/json" \
  -d '{"channel":"AppStore","productId":"string"}'

Example response

200application/json
{
  "paymentsEnabled": false,
  "planCode": "string",
  "planName": "string",
  "pendingPlanCode": "string",
  "status": "string",
  "canManage": false,
  "plans": [
    {
      "code": "string",
      "name": "string",
      "priceMonthMinor": 0,
      "priceCurrency": "string",
      "monthlyCredits": 0,
      "purchasable": false,
      "current": false,
      "pending": false,
      "priceSet": true
    }
  ],
  "channel": "None"
}
POST/api/v1/households/{householdId}/billing/store/sandbox/reset

Take away the household's App Store sandbox and Play test purchases

Adults only; a Junior member gets 403. For a household the platform admin allowed test purchases for (App Review, TestFlight): a plan bought in the sandbox ends now and is unlinked, so the household is on the default plan and can buy again, and every sandbox credit pack still held is taken back. A paid plan or pack is never touched. Answers the billing status as it is after. Safe to repeat. 403 (code store_sandbox_not_allowed) when the household may not make test purchases. scripts/review-household.mjs --reset calls it every night.

Parameters

NameInTypeRequiredDescription
householdIdpathstring (uuid)Required—

Responses

200OK
application/jsonBillingStatusResponse
401No session, or the session is no longer valid.
application/problem+jsonProblemDetails
403Forbidden
application/problem+jsonProblemDetails
404Not Found
application/problem+jsonProblemDetails
426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails
429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
503The server is down for maintenance (#4693). Retry-After says when to try again; problem type maintenance. Every call under /api answers this while maintenance mode is on, the version floor included.
application/problem+jsonProblemDetails
Headers
Retry-After
— Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.

Problem codes

The `code` in the problem body is what to branch on. `detail` is English, written for a log.

store_sandbox_not_allowed
— Only approved households can make test purchases.

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/billing/store/sandbox/reset"

Example response

200application/json
{
  "paymentsEnabled": false,
  "planCode": "string",
  "planName": "string",
  "pendingPlanCode": "string",
  "status": "string",
  "canManage": false,
  "plans": [
    {
      "code": "string",
      "name": "string",
      "priceMonthMinor": 0,
      "priceCurrency": "string",
      "monthlyCredits": 0,
      "purchasable": false,
      "current": false,
      "pending": false,
      "priceSet": true
    }
  ],
  "channel": "None"
}

Schemas

BillingChannel

Type

Values

NoneStripeAppStorePlay

Default "None"

BillingPlanResponse

PropertyTypeRequired
codestringRequired
namestringRequired
priceMonthMinorinteger (int32) | nullRequired
priceCurrencystringRequired
monthlyCreditsinteger (int32)Required
purchasablebooleanRequired
currentbooleanRequired
pendingbooleanRequired
priceSetboolean—

BillingPreviewKind

Type

Values

NewSubscriptionUpgradeDowngradeSame

BillingPreviewRequest

PropertyTypeRequired
planCodestringRequired

BillingPreviewResponse

PropertyTypeRequired
currentPlanCodestringRequired
planCodestringRequired
kindBillingPreviewKindRequired
dueNowMinorinteger (int32)Required
currencystringRequired
daysLeftinteger (int32)Required
periodDaysinteger (int32)Required
creditsNowinteger (int32)Required
creditsUsedinteger (int32)Required
creditsLeftAfterinteger (int32)Required
nextPaymentAtstring (date-time)Required
nextPaymentMinorinteger (int32)Required
appliesAtstring (date-time)Required
estimatedbooleanRequired
canManagebooleanRequired

BillingStatusResponse

PropertyTypeRequired
paymentsEnabledbooleanRequired
planCodestringRequired
planNamestringRequired
pendingPlanCodestring | nullRequired
statusstringRequired
canManagebooleanRequired
plansBillingPlanResponse[]Required
immediateStartConsentAtstring (date-time) | null—
channelBillingChannel—
storeProductsStoreProductResponse[] | null—

OpenPortalRequest

PropertyTypeRequired
returnUrlstringRequired

ProblemDetails

PropertyTypeRequired
typestring | null—
titlestring | null—
statusinteger (int32) | null—
detailstring | null—
instancestring | null—
codestring | null—

PublicPlanResponse

PropertyTypeRequired
codestringRequired
namestringRequired
priceMonthMinorinteger (int32) | nullRequired
priceCurrencystringRequired
monthlyCreditsinteger (int32)Required
welcomeCreditsinteger (int32)Required
purchasablebooleanRequired
priceSetboolean—

RedirectResponse

PropertyTypeRequired
urlstringRequired

StartCheckoutRequest

PropertyTypeRequired
planCodestringRequired
returnUrlstringRequired
startNowboolean—

StoreChannel

Type

Values

AppStorePlay

StoreIntentRequest

PropertyTypeRequired
channelStoreChannelRequired
productIdstringRequired
storefrontstring | null—

StoreIntentResponse

PropertyTypeRequired
accountTokenstring (uuid)Required
obfuscatedAccountIdstringRequired
productIdstringRequired

StoreProductKind

Type

Values

PlanCreditPack

StoreProductResponse

PropertyTypeRequired
kindStoreProductKindRequired
codestringRequired
namestringRequired
creditsinteger (int32)Required
appStoreProductIdstring | nullRequired
playProductIdstring | nullRequired
purchasablebooleanRequired
currentbooleanRequired

StoreVerifyRequest

PropertyTypeRequired
channelStoreChannelRequired
productIdstringRequired
signedTransactionstring | null—
purchaseTokenstring | null—