The amount charged to the customer at the time the subscription was activated. This replaces the first billing cycle charge; regular billing resumes from the next cycle.
A collection of key-value pairs that can be attached to an object for storing additional structured information. This is useful for capturing custom data or context-specific attributes.
Constraints:
Maximum of 50 key-value pairs allowed.
Each key must be no longer than 40 characters.
Each value must be a string and cannot exceed 500 characters.
Show child attributes
Example:
{ "orderId": "12345", "customerNote": "Deliver after 5 PM" }
The URL to redirect the customer to the xPay payment gateway for updating the payment method. Available only for subscriptions in TRIALING, ACTIVE, or UNPAID status.
Payment metadata for the subscription, including the payment method and card details if applicable
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"xPay","colors":{"primary":"#3bc2ff","light":"#3bc2ff","dark":"#0331ff"},"logo":{"light":"https://mintcdn.com/xpay/g26TzFabqZU05z4C/logo/light.svg?fit=max\u0026auto=format\u0026n=g26TzFabqZU05z4C\u0026q=85\u0026s=007fbae209bf88bae6f124ed06a79e04","dark":"https://mintcdn.com/xpay/g26TzFabqZU05z4C/logo/dark.svg?fit=max\u0026auto=format\u0026n=g26TzFabqZU05z4C\u0026q=85\u0026s=d445abb6483342208e929b08ec3a86b1","href":"https://xpaycheckout.com"},"favicon":"https://mintcdn.com/xpay/REkE_HjmjRViMmXV/favicon.png?fit=max\u0026auto=format\u0026n=REkE_HjmjRViMmXV\u0026q=85\u0026s=e98a1531e8c761f704c90cd01c2df5ff","api":{"mdx":{"auth":{"method":"basic","name":"[usernameName]:[passwordName]"},"server":"https://api.xpaycheckout.com"}},"background":{"decoration":"windows"},"navbar":{"links":[{"href":"mailto:hello@xpaycheckout.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.xpaycheckout.com"}},"footer":{"socials":{"website":"https://www.xpaycheckout.com/","linkedin":"https://www.linkedin.com/company/xpay-checkout"}},"integrations":{"posthog":{"apiKey":"phc_7aJLSdii3o5FaFeGUyQGl2x4Hf8K133tfU4zkmuE3sY"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"xpay","hasAudioNarration":false,"actualSubdomain":"xpay","customDomains":["docs.xpaycheckout.com"],"gitSource":{"type":"github","owner":"xpay-technologies","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adf0312808b7de58450a89b","collectionId":"167099e3-c643-4d27-8889-6b517b5adbf7","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf0312808b7de58450a89b"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6adf0312808b7de58450a89b","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"Developer Resources","count":80},{"language":"default","tag":"API References","count":36},{"language":"default","tag":"Webhooks","count":34},{"language":"default","tag":"Webhook Events","count":31},{"language":"default","tag":"Products","count":15},{"language":"default","tag":"Dashboard \u0026 Operations","count":12},{"language":"default","tag":"Intent Events","count":11},{"language":"default","tag":"Subscription Events","count":11},{"language":"default","tag":"Dispute Management","count":10},{"language":"default","tag":"Payments","count":9}]},"assistantConfig":{},"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},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"developer-resources/endpoints/subscriptions/get-subscription","slug":"/developer-resources/endpoints/subscriptions/get-subscription","pageMetadata":{"title":"Get Subscription","openapi":"GET /subscription/get-subscription/{subscriptionId}","description":"","href":"/developer-resources/endpoints/subscriptions/get-subscription"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const entityType_0=`subscription`;function _createMdxContent(props){const _components={a:`a`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Warning}=_components;if(!Warning)_missingMdxReference(`Warning`,true);return _jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Anti-Polling Warning`}),`: Avoid polling this endpoint; use webhooks for real-time `,entityType_0,` updates. See `,_jsx(_components.a,{href:`/developer-resources/rate-limits#quotas`,children:`Anti-Polling Policy`}),`.`]})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{entityType_0,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Subscription","openapi":"GET /subscription/get-subscription/{subscriptionId}","description":"","href":"/developer-resources/endpoints/subscriptions/get-subscription"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[521,539,"`subscription`,` upd"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"","parameters":["32374680-2118-48b3-a690-dff30af79ac8"],"responses":{"200":"7fba0c4b-234c-4451-804b-4964e45c811f","400":"c4772b78-c3d3-4e2c-914a-20087884643c"},"method":"get","type":"path","servers":["3326f4fb-4f32-40c7-8421-4cb311bc2da0"],"security":["ea68e7b4-b63a-4c0b-aef2-904d73dbf5f7"],"path":"/subscription/get-subscription/{subscriptionId}","baseUrlOptions":["https://api.xpaycheckout.com"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"32374680-2118-48b3-a690-dff30af79ac8":{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string","example":"sub_fooBOwYsaK50AEfK","isRequired":true,"description":"Unique identifier of the subscription","uniqueKey":"","typeLabel":"string"},"description":"Unique identifier of the subscription"}},"responses":{"7fba0c4b-234c-4451-804b-4964e45c811f":{"description":"Successful response with subscription details","content":{"application/json":{"schema":{"type":"object","properties":{"subscriptionId":{"type":"string","description":"Unique identifier of the subscription","example":"sub_fooBOwYsaK50AEfK","uniqueKey":"subscriptionId","typeLabel":"string"},"interval":{"type":"string","description":"The interval group between subscriptions.","enum":["DAY","WEEK","MONTH","YEAR"],"example":"MONTH","uniqueKey":"interval","typeLabel":"enum\u003cstring>"},"intervalCount":{"type":"integer","description":"The number of intervals between subscription billings. For example, `interval = MONTH` and `intervalCount = 3` bills every 3 months.","format":"int64","example":2,"uniqueKey":"intervalCount","typeLabel":"integer\u003cint64>"},"cycleCount":{"type":"integer","description":"The number of billing cycles for which the subscription will renew before ending. The first cycle is included in this count.","format":"int64","example":2,"uniqueKey":"cycleCount","typeLabel":"integer\u003cint64>"},"remainingCycleCount":{"type":"integer","description":"The number of billing cycles remaining for the subscription.","format":"int64","example":2,"uniqueKey":"remainingCycleCount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","description":"Three-letter currency code","example":"USD","uniqueKey":"currency","typeLabel":"string"},"amount":{"type":"integer","description":"The amount in lowest count unit (e.g., cents for USD)","format":"int64","example":100,"uniqueKey":"amount","typeLabel":"integer\u003cint64>"},"presentmentCurrency":{"type":"string","description":"The currency that the customer paid in","example":"USD","uniqueKey":"presentmentCurrency","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp of when the subscription was created","example":"2024-09-26T10:41:50.472+00:00","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","description":"The status of the subscription. Refer [subscription statuses](/products/subscription/subscription-statuses)","example":"CREATED","uniqueKey":"status","typeLabel":"string"},"upfrontAmount":{"type":"integer","format":"int64","description":"The amount charged to the customer at the time the subscription was activated. This replaces the first billing cycle charge; regular billing resumes from the next cycle.","example":200,"uniqueKey":"upfrontAmount","typeLabel":"integer\u003cint64>"},"trialPeriodCount":{"type":"integer","format":"int64","description":"The number of trial periods before the first billing cycle.","example":7,"uniqueKey":"trialPeriodCount","typeLabel":"integer\u003cint64>"},"trialPeriodInterval":{"type":"string","description":"The interval for the trial period.","enum":["DAY","WEEK","MONTH","YEAR"],"example":"DAY","uniqueKey":"trialPeriodInterval","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","description":"A collection of key-value pairs that can be attached to an object for storing additional structured information. This is useful for capturing custom data or context-specific attributes.\n\nConstraints:\n- Maximum of 50 key-value pairs allowed.\n- Each key must be no longer than 40 characters.\n- Each value must be a string and cannot exceed 500 characters.","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"example":{"orderId":"12345","customerNote":"Deliver after 5 PM"},"uniqueKey":"metadata","typeLabel":"object"},"updatePaymentMethodLink":{"type":"string","description":"The URL to redirect the customer to the xPay payment gateway for updating the payment method. Available only for subscriptions in `TRIALING`, `ACTIVE`, or `UNPAID` status.","example":"https://pay.xpaycheckout.com/subscription/update?subscription_id=sub_123","uniqueKey":"updatePaymentMethodLink","typeLabel":"string"},"paymentMetadata":{"type":"object","description":"Payment metadata for the subscription, including the payment method and card details if applicable","properties":{"paymentMethod":{"type":"string","description":"The payment method used for this attempt. Refer to [supported payment methods](/get-started/payment-methods-supported#payment-method-enums) for a complete list of available payment methods.","example":"CARD","uniqueKey":"paymentMetadata.paymentMethod","typeLabel":"string"},"cardMetadata":{"type":"object","description":"Card-specific metadata (only present for card payments)","properties":{"brand":{"type":"string","description":"The brand of the card (e.g., `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, `rupay`), among others","example":"visa","uniqueKey":"paymentMetadata.cardMetadata.brand","typeLabel":"string"},"country":{"type":"string","description":"Country code of the card issuer","example":"US","uniqueKey":"paymentMetadata.cardMetadata.country","typeLabel":"string"},"lastFourDigit":{"type":"string","description":"Last 4 digits of the card number","example":"4242","uniqueKey":"paymentMetadata.cardMetadata.lastFourDigit","typeLabel":"string"},"expiryMonth":{"type":"integer","format":"int64","description":"Card expiration month","example":12,"uniqueKey":"paymentMetadata.cardMetadata.expiryMonth","typeLabel":"integer\u003cint64>"},"expiryYear":{"type":"integer","format":"int64","description":"Card expiration year","example":2028,"uniqueKey":"paymentMetadata.cardMetadata.expiryYear","typeLabel":"integer\u003cint64>"},"cardType":{"type":"string","description":"Type of card funding, such as Credit or Debit","enum":["CREDIT","DEBIT","PREPAID","UNKNOWN"],"example":"CREDIT","uniqueKey":"paymentMetadata.cardMetadata.cardType","typeLabel":"enum\u003cstring>"}},"uniqueKey":"paymentMetadata.cardMetadata","typeLabel":"object"},"cardInstallmentMetadata":{"type":"object","description":"Card installment (EMI) metadata (only present for `CARD_INSTALLMENT` payments)","properties":{"cardInstallmentTenure":{"type":"string","description":"The installment tenure (in months) selected for this payment","enum":["three","six","nine","twelve"],"example":"three","uniqueKey":"paymentMetadata.cardInstallmentMetadata.cardInstallmentTenure","typeLabel":"enum\u003cstring>"}},"uniqueKey":"paymentMetadata.cardInstallmentMetadata","typeLabel":"object"}},"uniqueKey":"paymentMetadata","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"subscriptionId":"sub_fooBOwYsaK50AEfK","interval":"MONTH","intervalCount":2,"cycleCount":2,"remainingCycleCount":2,"currency":"USD","amount":100,"presentmentCurrency":"USD","createdAt":"2024-09-26T10:41:50.472+00:00","status":"CREATED","upfrontAmount":200,"trialPeriodCount":7,"trialPeriodInterval":"DAY","metadata":{"orderId":"12345","customerNote":"Deliver after 5 PM"},"updatePaymentMethodLink":"https://pay.xpaycheckout.com/subscription/update?subscription_id=sub_123","paymentMetadata":{"paymentMethod":"CARD","cardMetadata":{"brand":"visa","country":"US","lastFourDigit":"4242","expiryMonth":12,"expiryYear":2028,"cardType":"CREDIT"},"cardInstallmentMetadata":{"cardInstallmentTenure":"three"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"c4772b78-c3d3-4e2c-914a-20087884643c":{"description":"Invalid request, xSubscriptionId not found","content":{"application/json":{"schema":{"required":["errorCode","errorDescription"],"type":"object","properties":{"errorCode":{"type":"string","example":"bad_request","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"errorDescription":{"type":"string","example":"Failed to read request","isRequired":true,"uniqueKey":"errorDescription","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"bad_request","errorDescription":"Failed to read request"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ea68e7b4-b63a-4c0b-aef2-904d73dbf5f7":{"basicAuth":{"type":"http","scheme":"basic","scopes":[]}}},"servers":{"3326f4fb-4f32-40c7-8421-4cb311bc2da0":{"url":"https://api.xpaycheckout.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","scopes":[]},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"basicAuth","name":"Authorization"}],"title":"basicAuth"}]},"originalFileLocation":"developer-resources/endpoints/openapi.json"},"subdomain":"xpay","siteName":"xPay","title":"Get Subscription - xPay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T06:51:57.670Z","originalFileLocation":"developer-resources/endpoints/subscriptions/get-subscription.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=\"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=\"application-name\" content=\"xPay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/xpay/8HHwAkTUTKElZo4d/_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/xpay/8HHwAkTUTKElZo4d/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/xpay/8HHwAkTUTKElZo4d/_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/xpay/8HHwAkTUTKElZo4d/_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/xpay/8HHwAkTUTKElZo4d/_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/xpay/8HHwAkTUTKElZo4d/_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/xpay/8HHwAkTUTKElZo4d/_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/xpay/8HHwAkTUTKElZo4d/_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/xpay/8HHwAkTUTKElZo4d/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Subscription - xPay\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"xPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/get-subscription\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://xpay.mintlify.app/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Get+Subscription\u0026amp;theme=ec85a6ae573973953713558e\u0026amp;signature=965a64181ee6139c51f0a20e1b9d42f0e38b66e9f96bfcd6043f6cf823b81d86\">\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 Subscription - xPay\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://xpay.mintlify.app/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Get+Subscription\u0026amp;theme=ec85a6ae573973953713558e\u0026amp;signature=965a64181ee6139c51f0a20e1b9d42f0e38b66e9f96bfcd6043f6cf823b81d86\">\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/xpay/8HHwAkTUTKElZo4d/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"xPay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3bc2ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/get-subscription\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developer-resources/endpoints/subscriptions/get-subscription.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.xpaycheckout.com/#organization\",\"name\":\"xPay\",\"url\":\"https://docs.xpaycheckout.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/xpay/g26TzFabqZU05z4C/logo/light.svg?fit=max\u0026auto=format\u0026n=g26TzFabqZU05z4C\u0026q=85\u0026s=007fbae209bf88bae6f124ed06a79e04\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.xpaycheckout.com#website\",\"name\":\"xPay\",\"url\":\"https://docs.xpaycheckout.com\",\"publisher\":{\"@id\":\"https://docs.xpaycheckout.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/get-subscription#webpage\",\"url\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/get-subscription\",\"name\":\"Get Subscription\",\"dateModified\":\"2026-01-28T06:51:57.670Z\",\"isPartOf\":{\"@id\":\"https://docs.xpaycheckout.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/get-subscription#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/get-subscription#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Developer Resources\",\"item\":\"https://docs.xpaycheckout.com/developer-resources/getyourkeys\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API References\",\"item\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/payments/create-intent\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Subscriptions\",\"item\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/create-subscription\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Get Subscription\",\"item\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/get-subscription\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/get-subscription#apireference\",\"headline\":\"Get Subscription\",\"name\":\"Get Subscription\",\"url\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/get-subscription\",\"mainEntityOfPage\":{\"@id\":\"https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/get-subscription#webpage\"},\"dateModified\":\"2026-01-28T06:51:57.670Z\",\"publisher\":{\"@id\":\"https://docs.xpaycheckout.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.xpaycheckout.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"xPay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"xPay","nav":{"global":null,"groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/get-started/introduction"},{"title":"Onboarding","href":"/get-started/onboarding"},{"title":"Currencies Supported","href":"/get-started/currencies-supported"},{"title":"Payment Methods","href":"/get-started/payment-methods-supported"}]},{"group":"Products","pages":[{"group":"One Time Payments","pages":[{"title":"Overview","href":"/products/one-time-payments/overview"},{"title":"Integration Process","href":"/products/one-time-payments/integrationProcess"},{"title":"Payment Statuses","href":"/products/one-time-payments/payment-statuses"},{"title":"Error Codes","href":"/products/one-time-payments/error-codes"},{"title":"Saved Cards","href":"/products/one-time-payments/saved-cards"}]},{"group":"Subscription","pages":[{"title":"Overview","href":"/products/subscription/overview"},{"title":"Integration Process","href":"/products/subscription/integrationProcess"},{"title":"Subscription Statuses","href":"/products/subscription/subscription-statuses"},{"title":"Retry Mechanism","href":"/products/subscription/subscription-retry-mechanism"}]},{"title":"Payment Links","href":"/products/payment-links/payment-links"},{"group":"Setup Method","pages":[{"title":"Overview","href":"/products/setup-method/overview"},{"title":"Integration Process","href":"/products/setup-method/integrationProcess"}]},{"title":"Argus","href":"/products/argus/overview"},{"title":"Virtual Bank Accounts","href":"/products/virtual-bank-accounts/virtual-bank-accounts"},{"title":"Platform Connect","href":"/products/platform-connect/overview"}]},{"group":"Dashboard \u0026 Operations","pages":[{"title":"Team Roles \u0026 Permissions","href":"/dashboard-operations/team-roles-permissions"},{"title":"Payouts","href":"/dashboard-operations/payouts/payouts"},{"group":"Dispute Management","pages":[{"title":"Overview","href":"/dashboard-operations/dispute-management/dispute-management"},{"title":"How disputes work","href":"/dashboard-operations/dispute-management/how-disputes-work"},{"title":"Reason codes","href":"/dashboard-operations/dispute-management/reason-codes"},{"title":"Network code reference","href":"/dashboard-operations/dispute-management/network-code-reference"},{"title":"Responding by reason","href":"/dashboard-operations/dispute-management/responding-by-reason"},{"title":"Secondary evidence","href":"/dashboard-operations/dispute-management/secondary-evidence"},{"title":"Evidence guidelines","href":"/dashboard-operations/dispute-management/evidence-guidelines"},{"title":"Deadlines","href":"/dashboard-operations/dispute-management/deadlines"},{"title":"Reducing disputes","href":"/dashboard-operations/dispute-management/reducing-disputes"},{"title":"Dispute FAQ","href":"/dashboard-operations/dispute-management/faq"}]}]},{"group":"Developer Resources","pages":[{"title":"Get Started","href":"/developer-resources/getyourkeys"},{"title":"Authentication","href":"/developer-resources/authentication"},{"title":"Rate Limits","href":"/developer-resources/rate-limits"},{"title":"Idempotent Requests","href":"/developer-resources/idempotency"},{"title":"Errors","href":"/developer-resources/errors"},{"group":"API References","pages":[{"group":"Payments","pages":[{"title":"Create Intent","openapi":"POST /payments/create-intent","href":"/developer-resources/endpoints/payments/create-intent"},{"title":"Capture Payment","openapi":"POST /payments/capture-payment","href":"/developer-resources/endpoints/payments/capture-payment"},{"title":"Get Intent","openapi":"GET /payments/v2/get-intent/{xIntentId}","href":"/developer-resources/endpoints/payments/get-intent"},{"title":"Refund","openapi":"POST /payments/merchant/refund","href":"/developer-resources/endpoints/payments/refund"},{"title":"Cancel Payment","openapi":"POST /payments/cancel/{xIntentId}","href":"/developer-resources/endpoints/payments/cancel-payment"},{"title":"List Intents","openapi":"GET /payments/intents","href":"/developer-resources/endpoints/payments/list-intents"},{"title":"Charge Raw Card","openapi":"POST /payments/s2s/charge-raw-card","href":"/developer-resources/endpoints/payments/charge-raw-card"},{"title":"Get Refunds of an Intent","openapi":"GET /payments/refunds/{intentId}","href":"/developer-resources/endpoints/payments/get-refunds-for-intent"},{"title":"Get Refund","openapi":"GET /payments/refund/{refundId}","href":"/developer-resources/endpoints/payments/get-refund"}]},{"group":"Subscriptions","pages":[{"title":"Create Subscription","openapi":"POST /subscription/create","description":"","href":"/developer-resources/endpoints/subscriptions/create-subscription"},{"title":"Get Subscription","openapi":"GET /subscription/get-subscription/{subscriptionId}","href":"/developer-resources/endpoints/subscriptions/get-subscription"},{"title":"Edit Subscription","openapi":"POST /subscription/edit","description":null,"href":"/developer-resources/endpoints/subscriptions/edit-subscription"},{"title":"One Time Charge","openapi":"POST /subscription/merchant/one-time-charge","href":"/developer-resources/endpoints/subscriptions/one-time-charge"},{"title":"Manual Retry","openapi":"POST /subscription/manual-retry","href":"/developer-resources/endpoints/subscriptions/manual-retry"},{"title":"Pause Subscription","openapi":"POST /subscription/merchant/pause","href":"/developer-resources/endpoints/subscriptions/pause"},{"title":"Unpause Subscription","openapi":"POST /subscription/merchant/unpause","href":"/developer-resources/endpoints/subscriptions/unpause"},{"title":"Cancel Subscription","openapi":"POST /subscription/merchant/cancel","href":"/developer-resources/endpoints/subscriptions/cancel"}]},{"group":"Payment Links","pages":[{"title":"Payments Links","openapi":"POST /link/merchant/generate-link","href":"/developer-resources/endpoints/payment-links/generate-link"},{"title":"Subscription Link","openapi":"POST /subscription/link/merchant/generate-link","href":"/developer-resources/endpoints/payment-links/subscription-link"}]},{"group":"Customer","pages":[{"title":"Create Customer","openapi":"POST /customer/create","href":"/developer-resources/endpoints/customer/create-customer"},{"title":"Get Customer","openapi":"GET /customer/{customerId}","href":"/developer-resources/endpoints/customer/get-customer"},{"title":"List Payment Method Tokens","openapi":"GET /customer/{customerId}/payment-method-tokens","href":"/developer-resources/endpoints/customer/get-pm-tokens-for-customer"}]},{"group":"Setup Method","pages":[{"title":"Create Setup Method","openapi":"POST /setup-method/create","href":"/developer-resources/endpoints/setup-method/create-setup-method"},{"title":"Create S2S Setup Method","openapi":"POST /setup-method/s2s/create","href":"/developer-resources/endpoints/setup-method/create-s2s-setup-method"},{"title":"Get Setup Method","openapi":"GET /setup-method/{setupMethodId}","href":"/developer-resources/endpoints/setup-method/get-setup-method"},{"title":"Charge Tokenised PM","openapi":"POST /payments/charge-tokenised-pm","href":"/developer-resources/endpoints/setup-method/charge-tokenised-pm"},{"title":"Get Payment Method Token","openapi":"GET /payment-method-token/{paymentMethodTokenId}","href":"/developer-resources/endpoints/setup-method/get-payment-method-token"},{"title":"Delete Tokenised Payment Method","openapi":"POST /payment-method-token/delete","href":"/developer-resources/endpoints/setup-method/delete-tokenised-pm"}]},{"group":"Payouts","pages":[{"title":"Get Payout","openapi":"GET /balance/payouts/{payoutId}","href":"/developer-resources/endpoints/payouts/get-payout"},{"title":"List Payouts","openapi":"GET /balance/payouts","href":"/developer-resources/endpoints/payouts/list-payouts"}]},{"group":"Webhook Configuration","pages":[{"title":"Create a Webhook Configuration","openapi":"POST /webhook","href":"/developer-resources/endpoints/webhooks/create-webhook"},{"title":"List Webhook Configurations","openapi":"GET /webhook","href":"/developer-resources/endpoints/webhooks/get-webhooks"},{"title":"Get Webhook Configuration","openapi":"GET /webhook/{webhookConfigId}","href":"/developer-resources/endpoints/webhooks/get-webhook-by-id"},{"title":"Edit Webhook Configuration","openapi":"PUT /webhook/{webhookConfigId}","href":"/developer-resources/endpoints/webhooks/edit-webhook"},{"title":"Delete Webhook Configuration","openapi":"DELETE /webhook/{webhookConfigId}","href":"/developer-resources/endpoints/webhooks/delete-webhook"}]},{"group":"Argus","pages":[{"title":"Block Fingerprint by Intent","openapi":"POST /argus/block-fingerprint-by-intent","href":"/developer-resources/endpoints/argus/block-fingerprint-by-intent"}]}]},{"group":"Webhooks","pages":[{"title":"Webhooks Introduction","href":"/developer-resources/webhooks/introduction"},{"title":"Webhook Verification","href":"/developer-resources/webhooks/verification"},{"title":"Webhook Events Directory","href":"/developer-resources/webhooks/events-list"},{"group":"Webhook Events","pages":[{"group":"Intent Events","pages":[{"title":"Created","href":"/developer-resources/webhooks/events/intentEvents/created"},{"title":"Checkout Opened","href":"/developer-resources/webhooks/events/intentEvents/checkout_opened"},{"title":"Authorized","href":"/developer-resources/webhooks/events/intentEvents/authorized"},{"title":"Success","href":"/developer-resources/webhooks/events/intentEvents/success"},{"title":"Failed","href":"/developer-resources/webhooks/events/intentEvents/failed"},{"title":"Refunded","href":"/developer-resources/webhooks/events/intentEvents/refunded"},{"title":"Disputed","href":"/developer-resources/webhooks/events/intentEvents/disputed"},{"title":"Dispute Under Review","href":"/developer-resources/webhooks/events/intentEvents/dispute_under_review"},{"title":"Dispute Won","href":"/developer-resources/webhooks/events/intentEvents/disputedWon"},{"title":"Dispute Lost","href":"/developer-resources/webhooks/events/intentEvents/dispute_lost"},{"title":"Early Fraud Warning","href":"/developer-resources/webhooks/events/intentEvents/early_fraud_warning"}]},{"group":"Subscription Events","pages":[{"title":"Created","href":"/developer-resources/webhooks/events/subsEvents/created"},{"title":"Checkout Opened","href":"/developer-resources/webhooks/events/subsEvents/checkout_opened"},{"title":"Trialing","href":"/developer-resources/webhooks/events/subsEvents/trialing"},{"title":"Active","href":"/developer-resources/webhooks/events/subsEvents/active"},{"title":"Paused","href":"/developer-resources/webhooks/events/subsEvents/paused"},{"title":"Unpaused","href":"/developer-resources/webhooks/events/subsEvents/unpaused"},{"title":"Cycle Charged","href":"/developer-resources/webhooks/events/subsEvents/cycle_charged"},{"title":"Unpaid","href":"/developer-resources/webhooks/events/subsEvents/unpaid"},{"title":"Payment Method Updated","href":"/developer-resources/webhooks/events/subsEvents/payment_method_updated"},{"title":"Ended","href":"/developer-resources/webhooks/events/subsEvents/ended"},{"title":"Cancelled","href":"/developer-resources/webhooks/events/subsEvents/cancelled"}]},{"group":"Setup Method Events","pages":[{"title":"Setup Method Created","href":"/developer-resources/webhooks/events/setupMethodEvents/created"},{"title":"Setup Method Checkout Opened","href":"/developer-resources/webhooks/events/setupMethodEvents/checkout_opened"},{"title":"Setup Method Success","href":"/developer-resources/webhooks/events/setupMethodEvents/success"},{"title":"Setup Method Failed","href":"/developer-resources/webhooks/events/setupMethodEvents/failed"},{"title":"Payment Method Token Created","href":"/developer-resources/webhooks/events/setupMethodEvents/payment_method_token_created"},{"title":"Payment Method Token Deleted","href":"/developer-resources/webhooks/events/setupMethodEvents/payment_method_token_deleted"}]},{"group":"Payout Events","pages":[{"title":"Payout Initiated","href":"/developer-resources/webhooks/events/payoutEvents/initiated"},{"title":"Payout Success","href":"/developer-resources/webhooks/events/payoutEvents/success"}]},{"group":"Virtual Bank Account Events","pages":[{"title":"Virtual Bank Account Transaction","href":"/developer-resources/webhooks/events/vbaEvents/transaction"}]}]}]},{"title":null,"href":"/developer-resources/pagination"},{"group":"Sandbox","pages":[{"title":"Sandbox Environment","href":"/developer-resources/sandbox/sandbox"},{"title":"Payment Test Simulation","href":"/developer-resources/sandbox/payment-test-simulation"}]},{"title":"Mobile App Integration","href":"/developer-resources/mobileIntegration"},{"title":"Iframe Guidelines","href":"/developer-resources/iframeGuidelines"}]},{"group":"FAQs","pages":[{"title":"Frequently Asked Questions","href":"/faqs/overall-faq"},{"title":"xPay Card Installments","href":"/faqs/x-pay-card-installments"},{"title":"Klarna FAQs for Merchants","href":"/faqs/klarna-overview"},{"title":"Prohibited Activities / Businesses","href":"/faqs/prohibited-businesses"}]}]},"basePath":"","title":"Get Subscription - xPay","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}