Secret API key, created in the dashboard under Settings → API. Send it as Authorization: Bearer rk_secret_… from your server only. Publishable keys (pk_live_…) are for the native SDKs and reach the capture endpoints alone. An unknown key returns 401.
Response
Free photos left in the plan, prepaid credits, the packs on sale and how much of the monthly cap is used.
Photos the account can still capture: free ones left plus what the credits buy. null when the account has no capture limit.
Required range: x >= 0
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Rial","description":"Verify that a photo is real. Developer documentation for the Rial API, CLI and native SDKs.","colors":{"primary":"#1C1C1A","light":"#5EDCF0","dark":"#1C1C1A"},"logo":{"light":"https://mintcdn.com/rial-84ef3b7b/3BGl3crqe81CslFi/logo/rial-imagotype-light.svg?fit=max\u0026auto=format\u0026n=3BGl3crqe81CslFi\u0026q=85\u0026s=f87832b55472581c748e69fe09932a5e","dark":"https://mintcdn.com/rial-84ef3b7b/3BGl3crqe81CslFi/logo/rial-imagotype-dark.svg?fit=max\u0026auto=format\u0026n=3BGl3crqe81CslFi\u0026q=85\u0026s=7dbd4de118c7a30f86c49c048ef15f37","href":"https://www.rial.io"},"favicon":"https://mintcdn.com/rial-84ef3b7b/3BGl3crqe81CslFi/rial-isotype.svg?fit=max\u0026auto=format\u0026n=3BGl3crqe81CslFi\u0026q=85\u0026s=5a40aaa4a3032861397f006e49333f38","appearance":{"default":"dark","strict":false},"navbar":{"links":[{"icon":"message","href":"mailto:developers@rial.io","label":"Support"},{"href":"https://app.rial.io","label":"Dashboard"}],"primary":{"type":"button","label":"Get an API key","href":"https://app.rial.io/settings"}},"footer":{"links":[{"header":"RIAL","items":[{"label":"rial.io","href":"https://www.rial.io"},{"label":"Dashboard","href":"https://app.rial.io"},{"label":"Status","href":"https://status.rial.io"}]}]},"seo":{"metatags":{"og:description":"Verify that a photo is real. API, CLI and native SDKs."}},"fonts":{"heading":{"family":"Cormorant Garamond","weight":500},"body":{"family":"Inter","weight":400}},"styling":{"eyebrows":"breadcrumbs","codeblocks":"dark","latex":false},"integrations":{"posthog":{"apiKey":"phc_qkjPtdAahxszndgmyviMBWN8cvWk4rzqmG6cpw2oaQWh","sessionRecording":false}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode","mcp"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"rial-84ef3b7b","hasAudioNarration":false,"actualSubdomain":"rial-84ef3b7b","customDomains":["docs.rial.io"],"gitSource":{"type":"github","owner":"rial-ventures-inc","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ad68bc1d7bd5bf675578900","collectionId":"59a449d7-c502-4638-a5af-557b10c0eb11","liveDeploymentHistoryId":"6ad68bc1d7bd5bf675578900","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ad68bc1d7bd5bf675578900","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API reference","count":24},{"language":"default","tag":"Templates","count":9},{"language":"default","tag":"Get started","count":8},{"language":"default","tag":"SDKs \u0026 tools","count":7},{"language":"default","tag":"Verifications","count":7},{"language":"default","tag":"Start","count":6},{"language":"default","tag":"Databases","count":4},{"language":"default","tag":"Backend","count":3},{"language":"default","tag":"Mobile capture","count":3},{"language":"default","tag":"Credits","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"/* vietnamese */\n@font-face {\n font-family: 'Chivo Mono';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/chivomono/v11/mFT0WbgRxKvF_Z5eQMO9gxAD1XJ7.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Chivo Mono';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/chivomono/v11/mFT0WbgRxKvF_Z5eQMO9gxED1XJ7.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Chivo Mono';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/chivomono/v11/mFT0WbgRxKvF_Z5eQMO9gx8D1Q.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Chivo Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/chivomono/v11/mFT0WbgRxKvF_Z5eQMO9gxAD1XJ7.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Chivo Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/chivomono/v11/mFT0WbgRxKvF_Z5eQMO9gxED1XJ7.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Chivo Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/chivomono/v11/mFT0WbgRxKvF_Z5eQMO9gx8D1Q.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Chivo Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/chivomono/v11/mFT0WbgRxKvF_Z5eQMO9gxAD1XJ7.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Chivo Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/chivomono/v11/mFT0WbgRxKvF_Z5eQMO9gxED1XJ7.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Chivo Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/chivomono/v11/mFT0WbgRxKvF_Z5eQMO9gx8D1Q.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n:root{--rial-black:#000000;--rial-carbon:#1c1c1a;--rial-silver:#c9c9c9;--rial-parchment:#f1eae3;--rial-porcelain:#fffdf7;--rial-aqua:#5edcf0;--rial-aqua-ink:#0f9db3;--rial-lemon:#efecbc;--rial-ice:#b6f2e3;--rial-rule:#e4e3e0;--rial-mono:'Chivo Mono', 'SF Mono', ui-monospace, Menlo, Consolas, monospace}h1,h2,h3,h4,h5,h6{font-family:'Inter',ui-sans-serif,system-ui,sans-serif;font-weight:600;text-transform:none;letter-spacing:0}.prose h2:not([data-component-part]),h1#page-title{font-family:'Cormorant Garamond',Georgia,serif;font-weight:500;text-transform:uppercase;letter-spacing:.01em;line-height:1.1}h1#page-title{font-size:2.75rem}.prose h2:not([data-component-part]){font-size:1.9rem}code,kbd,pre,th{font-family:var(--rial-mono)}.rial-eyebrow,th{font-size:11px;font-weight:500;letter-spacing:.12em;text-transform:uppercase}.rial-eyebrow{display:inline-flex;align-items:center;gap:.6rem;font-family:var(--rial-mono);font-size:12px;font-weight:400;letter-spacing:.18em;color:var(--rial-carbon)}.dark .rial-eyebrow,.dark .rial-lede{color:var(--rial-porcelain)}.rial-eyebrow::before{content:'';width:9px;height:9px;border-radius:2px;background:var(--rial-aqua)}.rial-lede{font-size:1.25rem;line-height:1.5;margin:.75rem 0 1.5rem;color:var(--rial-carbon)}.card{border-radius:12px}.card h2,[data-component-part=card-title]{font-family:'Inter',ui-sans-serif,system-ui,sans-serif;font-weight:600;font-size:1.05rem;text-transform:none;letter-spacing:0;line-height:1.35}.card:hover{border-color:var(--rial-aqua-ink)}.dark .card:hover{border-color:var(--rial-aqua)}"}],"page":{"pagePath":"api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend","slug":"/api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend","pageMetadata":{"title":"Get the credit balance, saved card and monthly spend","description":"Your credit balance in photos, the packs on sale, the saved card and how much of the monthly cap is spent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/me/credits","href":"/api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Your credit balance in photos, the packs on sale, the saved card and how much of the monthly cap is spent.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Get the credit balance, saved card and monthly spend","description":"Your credit balance in photos, the packs on sale, the saved card and how much of the monthly cap is spent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/me/credits","href":"/api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Credits"],"summary":"Get the credit balance, saved card and monthly spend","security":["11c73270-3820-410f-a399-25e874e6daec"],"responses":{"200":"ffc13d9b-4876-4302-b3c3-c2187b4a7712","401":"010e30cd-8d0b-4f48-9f20-1c01be738435","403":"8d63e7ae-0d46-480d-9a8a-c8195b391675","503":"0125b081-e164-4e69-b155-c795a3ab4d40"},"description":"Your credit balance in photos, the packs on sale, the saved card and how much of the monthly cap is spent.","method":"get","type":"path","servers":["36fbb192-4b2b-49e9-a768-331bb5be3efb"],"path":"/v1/me/credits","baseUrlOptions":["https://api.rial.io"],"title":"Get the credit balance, saved card and monthly spend","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"ffc13d9b-4876-4302-b3c3-c2187b4a7712":{"description":"Free photos left in the plan, prepaid credits, the packs on sale and how much of the monthly cap is used.","content":{"application/json":{"schema":{"type":"object","properties":{"balance_cents":{"type":"integer","isRequired":true,"uniqueKey":"balance_cents","typeLabel":"integer"},"photos_available":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"photos_available","typeLabel":"integer"},"price_per_photo_cents":{"type":"integer","isRequired":true,"uniqueKey":"price_per_photo_cents","typeLabel":"integer"},"packs":{"type":"array","items":{"type":"object","properties":{"photos":{"type":"integer","isRequired":true,"uniqueKey":"packs.items.[INDEX].photos","typeLabel":"integer"},"amount_cents":{"type":"integer","isRequired":true,"uniqueKey":"packs.items.[INDEX].amount_cents","typeLabel":"integer"}},"required":["photos","amount_cents"],"uniqueKey":"packs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"packs","typeLabel":"object[]"},"payment_method":{"oneOf":[{"type":"object","properties":{"brand":{"type":"string","uniqueKey":"payment_method.oneOf.0.brand","typeLabel":"string"},"last4":{"type":"string","uniqueKey":"payment_method.oneOf.0.last4","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payment_method.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"brand":{"type":"string"},"last4":{"type":"string"}},"isRequired":true,"uniqueKey":"payment_method.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment_method","typeLabel":"object | null"},"monthly_cap_cents":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"monthly_cap_cents.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"monthly_cap_cents.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"monthly_cap_cents","typeLabel":"integer | null"},"month_spent_cents":{"type":"integer","isRequired":true,"uniqueKey":"month_spent_cents","typeLabel":"integer"},"plan":{"type":"object","properties":{"tier":{"type":"string","enum":["free","pro","enterprise"],"isRequired":true,"uniqueKey":"plan.tier","typeLabel":"enum\u003cstring>"},"photos_included":{"oneOf":[{"type":"integer","minimum":0,"description":"Photos the plan includes this period; null when unlimited.","isRequired":true,"uniqueKey":"plan.photos_included.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"description":"Photos the plan includes this period; null when unlimited.","isRequired":true,"uniqueKey":"plan.photos_included.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"plan.photos_included","typeLabel":"integer | null"},"photos_used":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"plan.photos_used","typeLabel":"integer"},"photos_left":{"oneOf":[{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"plan.photos_left.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"isRequired":true,"uniqueKey":"plan.photos_left.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"plan.photos_left","typeLabel":"integer | null"},"renews_at":{"oneOf":[{"type":"string","description":"When the included photos renew; null when the plan includes nothing now.","isRequired":true,"uniqueKey":"plan.renews_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the included photos renew; null when the plan includes nothing now.","isRequired":true,"uniqueKey":"plan.renews_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"plan.renews_at","typeLabel":"string | null"}},"required":["tier","photos_included","photos_used","photos_left","renews_at"],"description":"The photos the plan includes, used before any credit.","isRequired":true,"uniqueKey":"plan","typeLabel":"object"},"photos_left":{"oneOf":[{"type":"integer","minimum":0,"description":"Photos the account can still capture: free ones left plus what the credits buy. null when the account has no capture limit.","isRequired":true,"uniqueKey":"photos_left.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"description":"Photos the account can still capture: free ones left plus what the credits buy. null when the account has no capture limit.","isRequired":true,"uniqueKey":"photos_left.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"photos_left","typeLabel":"integer | null"}},"required":["balance_cents","photos_available","price_per_photo_cents","packs","payment_method","monthly_cap_cents","month_spent_cents","plan","photos_left"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"balance_cents":123,"photos_available":1,"price_per_photo_cents":123,"packs":[{"photos":123,"amount_cents":123}],"payment_method":{"brand":"\u003cstring>","last4":"\u003cstring>"},"monthly_cap_cents":123,"month_spent_cents":123,"plan":{"tier":"free","photos_included":1,"photos_used":1,"photos_left":1,"renews_at":"\u003cstring>"},"photos_left":1}}},"exampleType":"generated"}},"exampleType":"generated"},"010e30cd-8d0b-4f48-9f20-1c01be738435":{"description":"The session or secret API key is invalid.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"8d63e7ae-0d46-480d-9a8a-c8195b391675":{"description":"A person needs billing rights; a secret API key always may.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"0125b081-e164-4e69-b155-c795a3ab4d40":{"description":"Billing storage unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"decline_code":{"type":"string","uniqueKey":"error.decline_code","typeLabel":"string"},"month_spent_cents":{"type":"integer","uniqueKey":"error.month_spent_cents","typeLabel":"integer"},"monthly_cap_cents":{"type":"integer","uniqueKey":"error.monthly_cap_cents","typeLabel":"integer"},"idempotency_key":{"type":"string","uniqueKey":"error.idempotency_key","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","decline_code":"\u003cstring>","month_spent_cents":123,"monthly_cap_cents":123,"idempotency_key":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"11c73270-3820-410f-a399-25e874e6daec":{"bearerApiKey":{"type":"http","scheme":"bearer","bearerFormat":"rk_secret_\u003ckey>","description":"Secret API key, created in the dashboard under Settings → API. Send it as `Authorization: Bearer rk_secret_…` from your server only. Publishable keys (`pk_live_…`) are for the native SDKs and reach the capture endpoints alone. An unknown key returns 401.","scopes":[],"schemeName":"bearerApiKey"}}},"servers":{"36fbb192-4b2b-49e9-a768-331bb5be3efb":{"url":"https://api.rial.io","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"rk_secret_\u003ckey>","description":"Secret API key, created in the dashboard under Settings → API. Send it as `Authorization: Bearer rk_secret_…` from your server only. Publishable keys (`pk_live_…`) are for the native SDKs and reach the capture endpoints alone. An unknown key returns 401.","scopes":[],"schemeName":"bearerApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Secret API key, created in the dashboard under Settings → API. Send it as `Authorization: Bearer rk_secret_…` from your server only. Publishable keys (`pk_live_…`) are for the native SDKs and reach the capture endpoints alone. An unknown key returns 401.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerApiKey","name":"Authorization"}],"title":"bearerApiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"rial-84ef3b7b","siteName":"Rial","title":"Get the credit balance, saved card and monthly spend - Rial","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-16T02:35:03.229Z","originalFileLocation":"api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Your credit balance in photos, the packs on sale, the saved card and how much of the monthly cap is spent.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Rial\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rial-84ef3b7b/gbn7Xo3tfij-224p/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/rial-84ef3b7b/gbn7Xo3tfij-224p/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rial-84ef3b7b/gbn7Xo3tfij-224p/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/rial-84ef3b7b/gbn7Xo3tfij-224p/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/rial-84ef3b7b/gbn7Xo3tfij-224p/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rial-84ef3b7b/gbn7Xo3tfij-224p/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rial-84ef3b7b/gbn7Xo3tfij-224p/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/rial-84ef3b7b/gbn7Xo3tfij-224p/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/rial-84ef3b7b/gbn7Xo3tfij-224p/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get the credit balance, saved card and monthly spend - Rial\">\u003cmeta data-mint-head property=\"og:description\" content=\"Verify that a photo is real. API, CLI and native SDKs.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Rial\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.rial.io/api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://rial-84ef3b7b.mintlify.app/_mintlify/api/og/v2?division=Credits\u0026amp;title=Get+the+credit+balance%2C+saved+card+and+monthly+spend\u0026amp;description=Your+credit+balance+in+photos%2C+the+packs+on+sale%2C+the+saved+card+and+how+much+of+the+monthly+cap+is+spent.\u0026amp;theme=306c988e28abd98ddc2e84f3\u0026amp;signature=8d0ab2a552e8cb88b0e182d1fc290cffc438ac668e50032b2f3d0495a22948da\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get the credit balance, saved card and monthly spend - Rial\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Verify that a photo is real. API, CLI and native SDKs.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://rial-84ef3b7b.mintlify.app/_mintlify/api/og/v2?division=Credits\u0026amp;title=Get+the+credit+balance%2C+saved+card+and+monthly+spend\u0026amp;description=Your+credit+balance+in+photos%2C+the+packs+on+sale%2C+the+saved+card+and+how+much+of+the+monthly+cap+is+spent.\u0026amp;theme=306c988e28abd98ddc2e84f3\u0026amp;signature=8d0ab2a552e8cb88b0e182d1fc290cffc438ac668e50032b2f3d0495a22948da\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/rial-84ef3b7b/gbn7Xo3tfij-224p/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Rial\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1C1C1A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.rial.io/api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.rial.io/#organization\",\"name\":\"Rial\",\"url\":\"https://docs.rial.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/rial-84ef3b7b/3BGl3crqe81CslFi/logo/rial-imagotype-light.svg?fit=max\u0026auto=format\u0026n=3BGl3crqe81CslFi\u0026q=85\u0026s=f87832b55472581c748e69fe09932a5e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.rial.io#website\",\"name\":\"Rial\",\"url\":\"https://docs.rial.io\",\"publisher\":{\"@id\":\"https://docs.rial.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.rial.io/api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend#webpage\",\"url\":\"https://docs.rial.io/api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend\",\"name\":\"Get the credit balance, saved card and monthly spend\",\"description\":\"Your credit balance in photos, the packs on sale, the saved card and how much of the monthly cap is spent.\",\"dateModified\":\"2026-10-16T02:35:03.229Z\",\"isPartOf\":{\"@id\":\"https://docs.rial.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.rial.io/api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.rial.io/api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Rial\",\"item\":\"https://docs.rial.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get the credit balance, saved card and monthly spend\",\"item\":\"https://docs.rial.io/api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.rial.io/api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend#apireference\",\"headline\":\"Get the credit balance, saved card and monthly spend\",\"name\":\"Get the credit balance, saved card and monthly spend\",\"description\":\"Your credit balance in photos, the packs on sale, the saved card and how much of the monthly cap is spent.\",\"url\":\"https://docs.rial.io/api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend\",\"mainEntityOfPage\":{\"@id\":\"https://docs.rial.io/api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend#webpage\"},\"dateModified\":\"2026-10-16T02:35:03.229Z\",\"publisher\":{\"@id\":\"https://docs.rial.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.rial.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Rial\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Rial","nav":{"global":null,"tabs":[{"tab":"Get started","icon":"rocket","pages":[{"title":"Get started","href":""}]},{"tab":"SDKs \u0026 tools","icon":"code","pages":[{"title":"SDKs \u0026 tools","href":"/sdks/node"}]},{"tab":"API reference","icon":"book-open","groups":[{"group":"Credits","pages":[{"title":"Get the credit balance, saved card and monthly spend","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/me/credits","href":"/api-reference/credits/get-the-credit-balance-saved-card-and-monthly-spend"},{"title":"Get a link where a person saves the card agents will charge","description":"A link where a person saves the card agents charge. The monthly cap you ask for is printed on that page; nothing changes until they finish.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/me/credits/payment-method","href":"/api-reference/credits/get-a-link-where-a-person-saves-the-card-agents-will-charge"},{"title":"Buy a pack of photo credits with the saved card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/me/credits/top-ups","href":"/api-reference/credits/buy-a-pack-of-photo-credits-with-the-saved-card"}]},{"group":"Verifications","pages":[{"title":"List verifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/verifications","href":"/api-reference/verifications/list-verifications"},{"title":"Create a verification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/verifications","href":"/api-reference/verifications/create-a-verification"},{"title":"Get a verification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/verifications/{id}","href":"/api-reference/verifications/get-a-verification"},{"title":"Get optional damage localization results","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/verifications/{id}/damage-localization","href":"/api-reference/verifications/get-optional-damage-localization-results"},{"title":"Get the share-safe result","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/verifications/{id}/public","href":"/api-reference/verifications/get-the-share-safe-result"},{"title":"Get the event log","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/verifications/{id}/events","href":"/api-reference/verifications/get-the-event-log"},{"title":"Finalize with a narrative","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/verifications/{id}/finalize","href":"/api-reference/verifications/finalize-with-a-narrative"}]},{"group":"Audits","pages":[{"title":"Audit a photo for AI generation in one call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/audits/sync","href":"/api-reference/audits/audit-a-photo-for-ai-generation-in-one-call"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/link-templates","href":"/api-reference/templates/list-templates"},{"title":"Publish a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/link-templates","href":"/api-reference/templates/publish-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/link-templates/{slug}","href":"/api-reference/templates/delete-a-template"},{"title":"Update a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/link-templates/{slug}","href":"/api-reference/templates/update-a-template"},{"title":"Preview a CSV import","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/link-templates/{slug}/import/preview","href":"/api-reference/templates/preview-a-csv-import"},{"title":"Import a CSV","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/link-templates/{slug}/import","href":"/api-reference/templates/import-a-csv"},{"title":"Check an import","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/link-templates/imports/{jobId}","href":"/api-reference/templates/check-an-import"},{"title":"Simulate a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/link-templates/{slug}/simulate","href":"/api-reference/templates/simulate-a-template"},{"title":"Create a verification from a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/link-templates/{slug}/verifications","href":"/api-reference/templates/create-a-verification-from-a-template"}]},{"group":"Databases","pages":[{"title":"List your databases","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/databases","href":"/api-reference/databases/list-your-databases"},{"title":"Create a database from rows","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/databases","href":"/api-reference/databases/create-a-database-from-rows"},{"title":"Replace a database's rows","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/databases/{id}","href":"/api-reference/databases/replace-a-databases-rows"},{"title":"Rename a database","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/databases/{id}","href":"/api-reference/databases/rename-a-database"}]}]}]},"basePath":"","title":"Get the credit balance, saved card and monthly spend - Rial","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}