Returns the subscription for the account that owns this key’s tenant. Requires scope: billing:read. Tenancy: resolved from the API key’s tenant to its organization.
GET
/
api
/
v1
/
billing
/
subscription
Get the account subscription
curl --request GET \ --url https://api.railmail.app/api/v1/billing/subscription \ --header 'X-API-Key: <api-key>'
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Railmail","colors":{"primary":"#5E6AD2","light":"#7281FF","dark":"#7C5CFF"},"logo":{"light":"https://mintcdn.com/railmail/eQPO8l6Qj_PgLc7Q/logo/light.svg?fit=max\u0026auto=format\u0026n=eQPO8l6Qj_PgLc7Q\u0026q=85\u0026s=fbd8bfbe5319f8d5d56bd7ed314d1c3b","dark":"https://mintcdn.com/railmail/eQPO8l6Qj_PgLc7Q/logo/dark.svg?fit=max\u0026auto=format\u0026n=eQPO8l6Qj_PgLc7Q\u0026q=85\u0026s=a3c54365e0cfb6541b353dfaae9eb012"},"favicon":"https://mintcdn.com/railmail/vcWG7wH7qsVlUHJ8/favicon.svg?fit=max\u0026auto=format\u0026n=vcWG7wH7qsVlUHJ8\u0026q=85\u0026s=f2b2c0693cfd57b0b2646572a3b63c31","navbar":{"links":[{"href":"mailto:support@railmail.app","label":"Support"}],"primary":{"type":"button","label":"Portal","href":"https://app.railmail.app"}},"footer":{"socials":{"x":"https://x.com/railmail","github":"https://github.com/railmail","linkedin":"https://linkedin.com/company/railmail"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Portal","icon":"gauge","href":"https://app.railmail.app"}]},"languages":[{"language":"en","href":"en"},{"language":"pl","href":"pl"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"railmail","hasAudioNarration":false,"actualSubdomain":"railmail","customDomains":["docs.railmail.app"],"gitSource":{"type":"github","owner":"railmail","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"collectionId":"9171cb86-5ee9-4dc3-8726-ebd00ce2e670","liveDeploymentHistoryId":"6a4b8c741150eb12c03684c2","schemaVersion":"v3"},"entitlements":{},"buildId":"6a4b8c741150eb12c03684c2:success","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"en","tag":"API Reference","count":66},{"language":"pl","tag":"Dokumentacja API","count":66},{"language":"en","tag":"Endpoints","count":62},{"language":"pl","tag":"Endpointy","count":62},{"language":"en","tag":"Guides","count":20},{"language":"pl","tag":"Przewodniki","count":20},{"language":"en","tag":"User Guide","count":18},{"language":"pl","tag":"Przewodnik użytkownika","count":18},{"language":"en","tag":"Automations","count":8},{"language":"en","tag":"Segments","count":8},{"language":"pl","tag":"Automatyzacje","count":8},{"language":"pl","tag":"Segmenty","count":8},{"language":"en","tag":"Campaigns","count":7},{"language":"pl","tag":"Kampanie","count":7},{"language":"en","tag":"Overview","count":6},{"language":"en","tag":"Custom Fields","count":6},{"language":"en","tag":"Sending Domain","count":6},{"language":"pl","tag":"Domena wysyłkowa","count":6},{"language":"pl","tag":"Pola niestandardowe","count":6},{"language":"pl","tag":"Subskrybenci","count":5}]},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/billing/get-the-account-subscription","slug":"/api-reference/billing/get-the-account-subscription","pageMetadata":{"title":"Get the account subscription","description":"Returns the subscription for the account that owns this key's tenant. Requires scope: `billing:read`. Tenancy: resolved from the API key's tenant to its organization.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/billing/subscription","href":"/api-reference/billing/get-the-account-subscription","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns the subscription for the account that owns this key’s tenant. Requires scope: \", _jsx(_components.code, {\n children: \"billing:read\"\n }), \". Tenancy: resolved from the API key’s tenant to its organization.\"]\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":{"config":{},"pageMetadata":{"title":"Get the account subscription","description":"Returns the subscription for the account that owns this key's tenant. Requires scope: `billing:read`. Tenancy: resolved from the API key's tenant to its organization.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/billing/subscription","href":"/api-reference/billing/get-the-account-subscription","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Billing"],"summary":"Get the account subscription","description":"Returns the subscription for the account that owns this key's tenant. Requires scope: `billing:read`. Tenancy: resolved from the API key's tenant to its organization.","operationId":"getSubscription","responses":{"200":"de6dde71-5878-499a-8439-bf195dd22a87","401":"b5e989de-d2ea-45e3-b39f-d701a3dbd625","403":"12f8f995-87b7-4f5e-ad60-e9d8d11dd4d7","404":"2edd8078-5ecd-48d4-8ee5-a2e5ee45743b","429":"b41f4773-8806-40a2-901c-d3b795e6f650","500":"a59d837f-e804-4909-9422-1cc1b6f3a4b2"},"method":"get","type":"path","servers":["4c4afc3f-0b45-4478-88a3-f73c296cbb83"],"security":["01c64772-17ad-46a4-9a3a-d790677fe7b8"],"path":"/api/v1/billing/subscription","baseUrlOptions":["https://api.railmail.app"],"title":"Get the account subscription","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"de6dde71-5878-499a-8439-bf195dd22a87":{"description":"Subscription","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"integer","format":"int64","uniqueKey":"id.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","uniqueKey":"id.oneOf.1","typeLabel":"null"}],"uniqueKey":"id","typeLabel":"integer\u003cint64> | null"},"planTier":{"oneOf":[{"type":"string","uniqueKey":"planTier.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"planTier.oneOf.1","typeLabel":"null"}],"uniqueKey":"planTier","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"string | null"},"billingInterval":{"oneOf":[{"type":"string","uniqueKey":"billingInterval.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"billingInterval.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingInterval","typeLabel":"string | null"},"aiCreditsTier":{"oneOf":[{"type":"integer","uniqueKey":"aiCreditsTier.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"aiCreditsTier.oneOf.1","typeLabel":"null"}],"uniqueKey":"aiCreditsTier","typeLabel":"integer | null"},"pendingPlanTier":{"oneOf":[{"type":"string","uniqueKey":"pendingPlanTier.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"pendingPlanTier.oneOf.1","typeLabel":"null"}],"uniqueKey":"pendingPlanTier","typeLabel":"string | null"},"pendingAiCreditsTier":{"oneOf":[{"type":"integer","uniqueKey":"pendingAiCreditsTier.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"pendingAiCreditsTier.oneOf.1","typeLabel":"null"}],"uniqueKey":"pendingAiCreditsTier","typeLabel":"integer | null"},"pendingPlanEffectiveAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"pendingPlanEffectiveAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"pendingPlanEffectiveAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"pendingPlanEffectiveAt","typeLabel":"string\u003cdate-time> | null"},"currentPeriodStart":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"currentPeriodStart.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"currentPeriodStart.oneOf.1","typeLabel":"null"}],"uniqueKey":"currentPeriodStart","typeLabel":"string\u003cdate-time> | null"},"currentPeriodEnd":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"currentPeriodEnd.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"currentPeriodEnd.oneOf.1","typeLabel":"null"}],"uniqueKey":"currentPeriodEnd","typeLabel":"string\u003cdate-time> | null"},"cancelledAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"cancelledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"cancelledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancelledAt","typeLabel":"string\u003cdate-time> | null"},"cancellationReason":{"oneOf":[{"type":"string","uniqueKey":"cancellationReason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"cancellationReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellationReason","typeLabel":"string | null"},"cancelAtPeriodEnd":{"type":"boolean","uniqueKey":"cancelAtPeriodEnd","typeLabel":"boolean"},"isSendingAllowed":{"type":"boolean","uniqueKey":"isSendingAllowed","typeLabel":"boolean"},"limits":{"type":"object","properties":{"maxSubscribers":{"type":"integer","uniqueKey":"limits.maxSubscribers","typeLabel":"integer"},"maxCampaignsPerMonth":{"type":"integer","uniqueKey":"limits.maxCampaignsPerMonth","typeLabel":"integer"},"maxProjects":{"type":"integer","uniqueKey":"limits.maxProjects","typeLabel":"integer"},"maxAiRequestsPerMonth":{"type":"integer","uniqueKey":"limits.maxAiRequestsPerMonth","typeLabel":"integer"},"maxUsers":{"type":"integer","uniqueKey":"limits.maxUsers","typeLabel":"integer"},"maxEmailsPerMonth":{"type":"integer","uniqueKey":"limits.maxEmailsPerMonth","typeLabel":"integer"},"customFieldsEnabled":{"type":"boolean","uniqueKey":"limits.customFieldsEnabled","typeLabel":"boolean"},"automationsEnabled":{"type":"boolean","uniqueKey":"limits.automationsEnabled","typeLabel":"boolean"},"advancedSegmentsEnabled":{"type":"boolean","uniqueKey":"limits.advancedSegmentsEnabled","typeLabel":"boolean"},"customDomainEnabled":{"type":"boolean","uniqueKey":"limits.customDomainEnabled","typeLabel":"boolean"},"apiAccessEnabled":{"type":"boolean","uniqueKey":"limits.apiAccessEnabled","typeLabel":"boolean"},"prioritySupport":{"type":"boolean","uniqueKey":"limits.prioritySupport","typeLabel":"boolean"}},"uniqueKey":"limits","typeLabel":"object"},"createdAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"createdAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"createdAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time> | null"},"updatedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"updatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"updatedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":123,"planTier":"\u003cstring>","status":"\u003cstring>","billingInterval":"\u003cstring>","aiCreditsTier":123,"pendingPlanTier":"\u003cstring>","pendingAiCreditsTier":123,"pendingPlanEffectiveAt":"2023-11-07T05:31:56Z","currentPeriodStart":"2023-11-07T05:31:56Z","currentPeriodEnd":"2023-11-07T05:31:56Z","cancelledAt":"2023-11-07T05:31:56Z","cancellationReason":"\u003cstring>","cancelAtPeriodEnd":true,"isSendingAllowed":true,"limits":{"maxSubscribers":123,"maxCampaignsPerMonth":123,"maxProjects":123,"maxAiRequestsPerMonth":123,"maxUsers":123,"maxEmailsPerMonth":123,"customFieldsEnabled":true,"automationsEnabled":true,"advancedSegmentsEnabled":true,"customDomainEnabled":true,"apiAccessEnabled":true,"prioritySupport":true},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"b5e989de-d2ea-45e3-b39f-d701a3dbd625":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 7807 problem details.","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","uniqueKey":"instance","typeLabel":"string\u003curi>"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"errors":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"errors.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors, present on 400/422.","uniqueKey":"errors","typeLabel":"object"}},"required":["type","title","status"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"12f8f995-87b7-4f5e-ad60-e9d8d11dd4d7":{"description":"The API key lacks the required scope.","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 7807 problem details.","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","uniqueKey":"instance","typeLabel":"string\u003curi>"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"errors":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"errors.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors, present on 400/422.","uniqueKey":"errors","typeLabel":"object"}},"required":["type","title","status"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"2edd8078-5ecd-48d4-8ee5-a2e5ee45743b":{"description":"The resource does not exist in this project.","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 7807 problem details.","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","uniqueKey":"instance","typeLabel":"string\u003curi>"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"errors":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"errors.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors, present on 400/422.","uniqueKey":"errors","typeLabel":"object"}},"required":["type","title","status"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"b41f4773-8806-40a2-901c-d3b795e6f650":{"description":"Rate limit exceeded.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Requests allowed per minute.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Epoch seconds when the window resets.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 7807 problem details.","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","uniqueKey":"instance","typeLabel":"string\u003curi>"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"errors":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"errors.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors, present on 400/422.","uniqueKey":"errors","typeLabel":"object"}},"required":["type","title","status"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"a59d837f-e804-4909-9422-1cc1b6f3a4b2":{"description":"Unexpected server error.","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 7807 problem details.","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","uniqueKey":"instance","typeLabel":"string\u003curi>"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"errors":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"errors.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors, present on 400/422.","uniqueKey":"errors","typeLabel":"object"}},"required":["type","title","status"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"01c64772-17ad-46a4-9a3a-d790677fe7b8":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Project-scoped API key, format rm_(live|test)_... . May also be sent as `Authorization: Bearer rm_...`.","scopes":[]}}},"servers":{"4c4afc3f-0b45-4478-88a3-f73c296cbb83":{"url":"https://api.railmail.app","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Project-scoped API key, format rm_(live|test)_... . May also be sent as `Authorization: Bearer rm_...`.","scopes":[]},"schema":{"title":"X-API-Key","type":"string","description":"Project-scoped API key, format rm_(live|test)_... . May also be sent as `Authorization: Bearer rm_...`.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"railmail","siteName":"Railmail","title":"Get the account subscription - Railmail","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/billing/get-the-account-subscription","matchLevel":0},"pl":{"href":"/pl","matchLevel":4}}},"lastModified":"2026-07-01T10:41:39.596Z","originalFileLocation":"api-reference/billing/get-the-account-subscription.mdx","locale":"en"},"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=\"system\"}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=\"Returns the subscription for the account that owns this key\u0026#x27;s tenant. Requires scope: billing:read. Tenancy: resolved from the API key\u0026#x27;s tenant to its organization.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Railmail\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/svg+xml\" sizes=\"180x180\" href=\"https://mintcdn.com/railmail/vcWG7wH7qsVlUHJ8/favicon.svg?fit=max\u0026amp;auto=format\u0026amp;n=vcWG7wH7qsVlUHJ8\u0026amp;q=85\u0026amp;s=f2b2c0693cfd57b0b2646572a3b63c31\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"32x32\" href=\"https://mintcdn.com/railmail/vcWG7wH7qsVlUHJ8/favicon.svg?fit=max\u0026amp;auto=format\u0026amp;n=vcWG7wH7qsVlUHJ8\u0026amp;q=85\u0026amp;s=f2b2c0693cfd57b0b2646572a3b63c31\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"16x16\" href=\"https://mintcdn.com/railmail/vcWG7wH7qsVlUHJ8/favicon.svg?fit=max\u0026amp;auto=format\u0026amp;n=vcWG7wH7qsVlUHJ8\u0026amp;q=85\u0026amp;s=f2b2c0693cfd57b0b2646572a3b63c31\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/svg+xml\" href=\"https://mintcdn.com/railmail/vcWG7wH7qsVlUHJ8/favicon.svg?fit=max\u0026amp;auto=format\u0026amp;n=vcWG7wH7qsVlUHJ8\u0026amp;q=85\u0026amp;s=f2b2c0693cfd57b0b2646572a3b63c31\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get the account subscription - Railmail\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the subscription for the account that owns this key\u0026#x27;s tenant. Requires scope: billing:read. Tenancy: resolved from the API key\u0026#x27;s tenant to its organization.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Railmail\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.railmail.app/api-reference/billing/get-the-account-subscription\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://railmail.mintlify.app/_mintlify/api/og/v2?division=Billing\u0026amp;title=Get+the+account+subscription\u0026amp;description=Returns+the+subscription+for+the+account+that+owns+this+key%27s+tenant.+Requires+scope%3A+%60billing%3Aread%60.+Tenancy%3A+resolved+from+the+API+key%27s+tenant+to+its+organiz\u0026amp;theme=d16e1e842414a6c61e9fa955\u0026amp;signature=b3195ecf6858763018b0a0e6793926a072f302cb8195d33137e643458e09431f\">\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 account subscription - Railmail\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the subscription for the account that owns this key\u0026#x27;s tenant. Requires scope: billing:read. Tenancy: resolved from the API key\u0026#x27;s tenant to its organization.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://railmail.mintlify.app/_mintlify/api/og/v2?division=Billing\u0026amp;title=Get+the+account+subscription\u0026amp;description=Returns+the+subscription+for+the+account+that+owns+this+key%27s+tenant.+Requires+scope%3A+%60billing%3Aread%60.+Tenancy%3A+resolved+from+the+API+key%27s+tenant+to+its+organiz\u0026amp;theme=d16e1e842414a6c61e9fa955\u0026amp;signature=b3195ecf6858763018b0a0e6793926a072f302cb8195d33137e643458e09431f\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/railmail/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Railmail\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5E6AD2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.railmail.app/api-reference/billing/get-the-account-subscription\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/billing/get-the-account-subscription.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.railmail.app/#organization\",\"name\":\"Railmail\",\"url\":\"https://docs.railmail.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/railmail/eQPO8l6Qj_PgLc7Q/logo/light.svg?fit=max\u0026auto=format\u0026n=eQPO8l6Qj_PgLc7Q\u0026q=85\u0026s=fbd8bfbe5319f8d5d56bd7ed314d1c3b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.railmail.app#website\",\"name\":\"Railmail\",\"url\":\"https://docs.railmail.app\",\"publisher\":{\"@id\":\"https://docs.railmail.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.railmail.app/api-reference/billing/get-the-account-subscription#webpage\",\"url\":\"https://docs.railmail.app/api-reference/billing/get-the-account-subscription\",\"name\":\"Get the account subscription\",\"description\":\"Returns the subscription for the account that owns this key's tenant. Requires scope: billing:read. Tenancy: resolved from the API key's tenant to its organization.\",\"dateModified\":\"2026-07-01T10:41:39.596Z\",\"isPartOf\":{\"@id\":\"https://docs.railmail.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.railmail.app/api-reference/billing/get-the-account-subscription#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.railmail.app/api-reference/billing/get-the-account-subscription#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.railmail.app/api-reference/subscribers/list-subscribers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get the account subscription\",\"item\":\"https://docs.railmail.app/api-reference/billing/get-the-account-subscription\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.railmail.app/api-reference/billing/get-the-account-subscription#apireference\",\"headline\":\"Get the account subscription\",\"name\":\"Get the account subscription\",\"description\":\"Returns the subscription for the account that owns this key's tenant. Requires scope: billing:read. Tenancy: resolved from the API key's tenant to its organization.\",\"url\":\"https://docs.railmail.app/api-reference/billing/get-the-account-subscription\",\"mainEntityOfPage\":{\"@id\":\"https://docs.railmail.app/api-reference/billing/get-the-account-subscription#webpage\"},\"dateModified\":\"2026-07-01T10:41:39.596Z\",\"publisher\":{\"@id\":\"https://docs.railmail.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.railmail.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Railmail\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Railmail","nav":{"global":{"anchors":[{"anchor":"Portal","icon":"gauge","href":"https://app.railmail.app"}]},"languages":[{"language":"en","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/en"}]},{"tab":"API Reference","pages":[{"group":"Overview","pages":[{"title":"Introduction","href":"/en/api-reference/introduction"},{"title":"Authentication","href":"/en/api-reference/authentication"},{"title":"Errors","href":"/en/api-reference/errors"},{"title":"Rate limits","href":"/en/api-reference/rate-limits"}]},{"group":"Endpoints","pages":[{"group":"Subscribers","pages":[{"title":"List subscribers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/subscribers","href":"/api-reference/subscribers/list-subscribers"},{"title":"Create a subscriber","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/subscribers","href":"/api-reference/subscribers/create-a-subscriber"},{"title":"Get a subscriber by email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/subscribers/{email}","href":"/api-reference/subscribers/get-a-subscriber-by-email"},{"title":"Delete a subscriber","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/subscribers/{email}","href":"/api-reference/subscribers/delete-a-subscriber"},{"title":"Update a subscriber","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/subscribers/{email}","href":"/api-reference/subscribers/update-a-subscriber"}]},{"group":"Topics","pages":[{"title":"List topics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/topics","href":"/api-reference/topics/list-topics"},{"title":"Create a topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/topics","href":"/api-reference/topics/create-a-topic"},{"title":"Get a topic by key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/topics/{topicKey}","href":"/api-reference/topics/get-a-topic-by-key"},{"title":"Delete a topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/topics/{topicKey}","href":"/api-reference/topics/delete-a-topic"},{"title":"Update a topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/topics/{topicKey}","href":"/api-reference/topics/update-a-topic"}]},{"group":"Consents","pages":[{"title":"List a subscriber's consents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/subscribers/{email}/consents","href":"/api-reference/consents/list-a-subscribers-consents"},{"title":"Grant consent for a topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/subscribers/{email}/consents","href":"/api-reference/consents/grant-consent-for-a-topic"},{"title":"Revoke consent for a topic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/subscribers/{email}/consents/{topicKey}","href":"/api-reference/consents/revoke-consent-for-a-topic"}]},{"group":"Suppressions","pages":[{"title":"Add an email to the suppression list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/suppressions","href":"/api-reference/suppressions/add-an-email-to-the-suppression-list"},{"title":"Check whether an email is suppressed","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/suppressions/{email}","href":"/api-reference/suppressions/check-whether-an-email-is-suppressed"},{"title":"Remove an email from the suppression list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/suppressions/{email}","href":"/api-reference/suppressions/remove-an-email-from-the-suppression-list"}]},{"group":"Campaigns","pages":[{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/campaigns","href":"/api-reference/campaigns/create-a-campaign"},{"title":"Get a campaign by key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/campaigns/{campaignKey}","href":"/api-reference/campaigns/get-a-campaign-by-key"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/campaigns/{campaignKey}","href":"/api-reference/campaigns/delete-a-campaign"},{"title":"Update a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/campaigns/{campaignKey}","href":"/api-reference/campaigns/update-a-campaign"},{"title":"Schedule a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/campaigns/{campaignKey}/schedule","href":"/api-reference/campaigns/schedule-a-campaign"},{"title":"Send a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/campaigns/{campaignKey}/send","href":"/api-reference/campaigns/send-a-campaign"}]},{"group":"Segments","pages":[{"title":"List segments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/segments","href":"/api-reference/segments/list-segments"},{"title":"Create a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/segments","href":"/api-reference/segments/create-a-segment"},{"title":"Get a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/segments/{segmentId}","href":"/api-reference/segments/get-a-segment"},{"title":"Delete a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/segments/{segmentId}","href":"/api-reference/segments/delete-a-segment"},{"title":"Update a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/segments/{segmentId}","href":"/api-reference/segments/update-a-segment"},{"title":"List segment members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/segments/{segmentId}/members","href":"/api-reference/segments/list-segment-members"},{"title":"Add members to a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/segments/{segmentId}/members","href":"/api-reference/segments/add-members-to-a-segment"},{"title":"Remove members from a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/segments/{segmentId}/members","href":"/api-reference/segments/remove-members-from-a-segment"}]},{"group":"Custom Fields","pages":[{"title":"List active custom fields","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/custom-fields","href":"/api-reference/custom-fields/list-active-custom-fields"},{"title":"Create a custom field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/custom-fields","href":"/api-reference/custom-fields/create-a-custom-field"},{"title":"Get a custom field by key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/custom-fields/{key}","href":"/api-reference/custom-fields/get-a-custom-field-by-key"},{"title":"Archive a custom field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/custom-fields/{key}","href":"/api-reference/custom-fields/archive-a-custom-field"},{"title":"Update custom field details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/custom-fields/{key}/details","href":"/api-reference/custom-fields/update-custom-field-details"},{"title":"Update custom field config","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/custom-fields/{key}/config","href":"/api-reference/custom-fields/update-custom-field-config"}]},{"group":"Automations","pages":[{"title":"List automations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automations","href":"/api-reference/automations/list-automations"},{"title":"Create an automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automations","href":"/api-reference/automations/create-an-automation"},{"title":"Get an automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automations/{automationId}","href":"/api-reference/automations/get-an-automation"},{"title":"Delete an automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/automations/{automationId}","href":"/api-reference/automations/delete-an-automation"},{"title":"Update an automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/automations/{automationId}","href":"/api-reference/automations/update-an-automation"},{"title":"Update automation content","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/automations/{automationId}/content","href":"/api-reference/automations/update-automation-content"},{"title":"Activate an automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automations/{automationId}/activate","href":"/api-reference/automations/activate-an-automation"},{"title":"Pause an automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automations/{automationId}/pause","href":"/api-reference/automations/pause-an-automation"}]},{"group":"Sending Domain","pages":[{"title":"Get the project's sending domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/sending-domain","href":"/api-reference/sending-domain/get-the-projects-sending-domain"},{"title":"Set up a custom sending domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/sending-domain","href":"/api-reference/sending-domain/set-up-a-custom-sending-domain"},{"title":"Remove the custom sending domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/sending-domain","href":"/api-reference/sending-domain/remove-the-custom-sending-domain"},{"title":"Update the sending domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/sending-domain","href":"/api-reference/sending-domain/update-the-sending-domain"},{"title":"Get DNS setup instructions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/sending-domain/dns-instructions","href":"/api-reference/sending-domain/get-dns-setup-instructions"},{"title":"Verify the domain's DNS records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/sending-domain/verify-dns","href":"/api-reference/sending-domain/verify-the-domains-dns-records"}]},{"group":"Campaign Reports","pages":[{"title":"Get the campaign report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/campaigns/{campaignKey}/report","href":"/api-reference/campaign-reports/get-the-campaign-report"},{"title":"Get live campaign statistics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/campaigns/{campaignKey}/report/statistics","href":"/api-reference/campaign-reports/get-live-campaign-statistics"},{"title":"Get the statistics timeline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/campaigns/{campaignKey}/report/timeline","href":"/api-reference/campaign-reports/get-the-statistics-timeline"},{"title":"Export statistics as CSV","description":"Returns the campaign statistics as a CSV file. Requires scope: `reports:read`. Tenancy: scoped to the API key's project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/campaigns/{campaignKey}/report/export","href":"/api-reference/campaign-reports/export-statistics-as-csv"}]},{"group":"Billing","pages":[{"title":"Get the account subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/billing/subscription","href":"/api-reference/billing/get-the-account-subscription"},{"title":"List available plans","description":"Returns the plans available to the account. Requires scope: `billing:read`. Tenancy: resolved from the API key's tenant to its organization.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/billing/plans","href":"/api-reference/billing/list-available-plans"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/billing/invoices","href":"/api-reference/billing/list-invoices"},{"title":"Get the usage summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/billing/usage","href":"/api-reference/billing/get-the-usage-summary"}]},{"group":"AI Credits","pages":[{"title":"Get the AI credit balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/credits/balance","href":"/api-reference/ai-credits/get-the-ai-credit-balance"},{"title":"List AI credit transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/credits/transactions","href":"/api-reference/ai-credits/list-ai-credit-transactions"}]},{"group":"Project","pages":[{"title":"Get the current project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/project","href":"/api-reference/project/get-the-current-project"}]}]}]}]},{"language":"pl","pages":[{"title":"pl","href":"/pl"}]}]},"title":"Get the account subscription - Railmail","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}