Endpoints
Full request and response schemas are in API reference.
Account identity
email, userId, and apiKeyId. Use it at startup to
verify that an automation is running under the intended account.
Credits
availableBalance, upcoming renewal dates, top-up credit
packages, and subscription renewal metadata.
Billing catalog
planQuantities lists every owned subscription quantity together with its
provider; check enabled because maxed-out subscriptions remain in the list.
planQuantity identifies the automatic target when the default provider or a
sole eligible alternative can be increased. When no automatic target exists,
its nullable fields distinguish a sole disabled owner from an unresolved owner.
For eligible accounts, subscription.monthly.priceExperiment identifies the
active price experiment, assigned variant, and effective unit price in cents.
The field can be null or omitted when no experiment applies.
Checkout
"productType": "topup" and a positive quantity. Top-ups
are available only while the account has an active subscription.
Subscriptions also require cycle as monthly or yearly.
Each new checkout uses the currently configured default payment provider. The
response identifies it in provider and includes both checkoutId and the
provider session identifier in sessionId.