Create a top-up checkout

posthttps://api.mentio.dev/v1/billing/top-ups

Get a hosted checkout URL for a top-up; this call charges nothing.

The balance is credited within a minute of payment, and paused tracking resumes. successUrl must be on a trusted origin; omit it for the dashboard.

Authentication

AuthorizationBearer <token>Required

An API key (mk_live_...) from the dashboard or an OAuth access token. See Authentication.

Header parameters

idempotency-keystringOptional

A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.

1 to 255 characters

Body

application/json

amountCentsintegerRequired

Amount to add, in USD cents (2000 to 500000). Prefilled at checkout, editable there.

2000 to 500000

successUrlstringOptional

Where the customer lands after paying: a page on an origin this deployment trusts (the dashboard). Omit it and the dashboard's billing page is used.

0 to 2000 charactersuri

Response

200Hosted checkout URL with the amount prefilled

urlstringRequired

Hosted Polar checkout URL.

400Invalid amount or disallowed successUrl

+Show 1 property

errorobjectRequired

The error.

+Show 4 properties

codestringRequired

Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.

+Show 46 enum values

unauthorizedforbiddenread_only_keyvalidation_errornot_foundinvalid_cursorpayload_too_largeidempotency_key_in_useidempotency_key_reusedrate_limitedduplicate_keywordinsufficient_balancekeyword_limit_reachedbilling_not_configuredorder_not_creditedschedule_requiredunknown_channelnot_a_digesthourly_email_unsupportedslack_not_connectedslack_not_configuredtelegram_not_configuredfeed_unreadablefeed_login_requiredfeed_login_expiredfeed_limit_reachedfeed_auth_not_configuredemail_not_configuredinvalid_assigneeclassification_pendinginvalid_memberalready_memberlast_ownerduplicate_segmentfilter_too_complexduplicate_viewduplicate_groupdefault_groupdefault_group_contextgroup_changedinvalid_signaturewebhook_not_configuredinvalid_tokenprotected_userupstream_unavailableinternal_error

messagestringRequired

Human-readable detail; may change between releases.

requestIdstringOptional

The id of this request (also the X-Request-Id response header); quote it to support.

retryAfterSecondsintegerOptional

For rate_limited and other retryable errors: how long to wait before retrying (mirrors the Retry-After header).

401Missing or invalid credentials

+Show 1 property

errorobjectRequired

The error.

+Show 4 properties

codestringRequired

Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.

+Show 46 enum values

messagestringRequired

Human-readable detail; may change between releases.

requestIdstringOptional

The id of this request (also the X-Request-Id response header); quote it to support.

retryAfterSecondsintegerOptional

For rate_limited and other retryable errors: how long to wait before retrying (mirrors the Retry-After header).

404Workspace has no owner to bill

+Show 1 property

errorobjectRequired

The error.

+Show 4 properties

codestringRequired

Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.

+Show 46 enum values

messagestringRequired

Human-readable detail; may change between releases.

requestIdstringOptional

The id of this request (also the X-Request-Id response header); quote it to support.

retryAfterSecondsintegerOptional

For rate_limited and other retryable errors: how long to wait before retrying (mirrors the Retry-After header).

429More than a few checkouts a minute for one workspace

+Show 1 property

errorobjectRequired

The error.

+Show 4 properties

codestringRequired

Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.

+Show 46 enum values

messagestringRequired

Human-readable detail; may change between releases.

requestIdstringOptional

The id of this request (also the X-Request-Id response header); quote it to support.

retryAfterSecondsintegerOptional

For rate_limited and other retryable errors: how long to wait before retrying (mirrors the Retry-After header).

503Billing is not configured on this deployment

+Show 1 property

errorobjectRequired

The error.

+Show 4 properties

codestringRequired

Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.

+Show 46 enum values

messagestringRequired

Human-readable detail; may change between releases.

requestIdstringOptional

The id of this request (also the X-Request-Id response header); quote it to support.

retryAfterSecondsintegerOptional

For rate_limited and other retryable errors: how long to wait before retrying (mirrors the Retry-After header).

https://api.mentio.dev/v1/billing/top-ups

const response = await fetch('https://api.mentio.dev/v1/billing/top-ups', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MENTIO_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "amountCents": 2000
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "url": "https://example.com"
}

View as Markdown Ask ChatGPT about this page Ask Claude about this page OpenAPI specification Get an API key