> ## Documentation Index > Fetch the complete documentation index at: https://docs.payaza.africa/llms.txt > Use this file to discover all available pages before exploring further. # Get Subscription > It retrieves the details of a specific subscription. ## OpenAPI ````yaml /openapi.json get /subscription/api/v1/subscriptions/{id} openapi: 3.0.1 info: title: Payaza Documentation version: 2.0.0 description: >- API reference for processing payments using Card, Bank Transfer, USSD, and QR Code methods. servers: - url: https://api.payaza.africa/live security: - ApiKeyAuth: [] - TenantID: [] - ProductID: [] tags: - name: Transfers description: >- Transfers are transactions made from your Payaza account to beneficiaries. Merchants can instantly transfer funds from their available balance. For every transfer, you need to specify the amount and the beneficiary’s details. You become eligible to make transfers after you have been verified. (you sign up, finish account activation and KYC verification). - name: Payaza Account description: >- This is our internal account that can be used to make payouts to other bank accounts, in single or in bulk. The Payaza account can also be used to receive settlements. It can also be used to track the transfer status of your transactions and check your balance instantly - name: Sub Accounts description: >- This enables you to establish Sub Payaza accounts for your customers. Each sub-account comes with an assigned static virtual account, facilitating direct funding for individual accounts. Furthermore, the Main Payaza account can directly initiate funding for each sub-account. These sub-accounts serve the purpose of managing unique account positions or balances and facilitating disbursements from these positions to specified beneficiaries. - name: EUR Accounts description: >- This endpoints enable you to create EUR subaccounts which can be used to make transfers as required . - name: Apple Pay and Google Pay description: >- Apple Pay and Google Pay give your customers a fast, familiar, and secure way to complete payments. Our APIs provide a gateway to provide these services to your users for a smooth payment experience. - name: Virtual Accounts description: >- Virtual Accounts are bank accounts that are created for a specific purpose and last for specified durations. Virtual accounts are issued by Payaza’s partner banks. Our virtual account APIs can be used to create virtual accounts and perform other tasks relevant to virtual accounts. Virtual accounts are created to foster easy payment collections for your business and platform. Static/Reserved Account: This virtual account is created by the merchant and remains valid indefinitely. It can be used multiple times and does not expire. Dynamic Account: This virtual account is generated for a specific transaction or purpose. Please note that dynamic virtual account remains valid for a temporary period of time or until a payment of the specified amount is received. Upon expiry, a merchant can generate another one for a different purpose. - name: Card Collection description: >- The Card Collection APIs can be used to make card transactions, refund transactions that have been performed, check the status of a transaction and so much more. - name: Card Tokenisation description: >- The Card Tokenisation APIs are used to create card tokens, charge cards using tokens, retrieve all tokens created by a merchant account and deleting any card token as desired. - name: Refunds And Chargebacks description: >- The Refunds and Chargeback APIs are used to initiate refunds, view your refund and chargeback history and so much more. - name: Branches description: >- The Refunds and Chargeback APIs are used to initiate refunds, view your refund and chargeback history and so much more. - name: Auth-Capture-Void description: >- The Auth-Capture-Void APIs provide a two-phase payment process where transactions are first authorized, then captured or voided. This allows merchants to hold funds and complete the transaction in the future. - name: Momo and ZAR Collections description: APIs for MoMo, ZAR and XOF collections. - name: Check Transaction Status(Merchant Reference) description: >- This endpoint is used to check the transaction status of a transaction using the Merchant Reference.. paths: /subscription/api/v1/subscriptions/{id}: get: tags: - Subscription Reads summary: Get Subscription description: It retrieves the details of a specific subscription. parameters: - name: id in: path required: true schema: type: string description: The Plan ID. responses: '200': description: Request Successful content: application/json: schema: $ref: '#/components/schemas/getSubscriptionResponse' examples: Get Subscription: summary: Get Subscription value: success: true message: Success data: id: 21 customerId: test-trial customerEmail: johndoe@gmail.com firstName: null lastName: null customerAuthorizedAt: null status: ACTIVE currentPeriodStart: '2026-07-08T20:20:32.893234' currentPeriodEnd: '2026-07-09T20:20:32.893236' nextChargeDate: '2026-07-09T20:20:32.893236' trialEndDate: null pauseResumesAt: null cancelAt: null pausedAt: null cancelledAt: null cancellationReason: null cardExpiryAlertSent: false connectionMode: Live enrollmentReference: SUBREF_FF29C28B70034065A6 enrollmentTxnReference: SUB_ENROLL_21_1783539495235 chargeMode: DIRECT_CHARGE metadata: null createdAt: '2026-07-08T19:38:15.22973' updatedAt: '2026-07-08T20:20:33.000927' customerBearsFee: false enrollConfirmed: true '400': description: Invalid request security: - ApiKeyAuth: - Payaza {{Public API Key In Base64}} components: schemas: getSubscriptionResponse: title: Get Subscription Response type: object properties: success: type: boolean description: Indicates if the request was successful. example: true message: type: string description: Descriptive message regarding the operation. example: Success data: type: object description: >- The payload containing the comprehensive subscription information record. properties: id: type: integer description: Unique internal identifier for the subscription. example: 21 customerId: type: string description: Unique reference identifier assigned to the customer layer. example: test-trial customerEmail: type: string format: email description: The email address of the customer subscribing to the plan. example: johndoe@gmail.com firstName: type: string nullable: true description: First name of the customer. example: null lastName: type: string nullable: true description: Last name of the customer. example: null customerAuthorizedAt: type: string format: date-time nullable: true description: >- Timestamp indicating when the customer explicitly authorized billing. example: null status: type: string description: The current operational status lifecycle of the subscription. example: ACTIVE currentPeriodStart: type: string format: date-time description: >- Timestamp tracking when the current billing sequence window opened. example: '2026-07-08T20:20:32.893234' currentPeriodEnd: type: string format: date-time description: >- Timestamp tracking when the current billing sequence window closes. example: '2026-07-09T20:20:32.893236' nextChargeDate: type: string format: date-time description: >- The next scheduled automated engine billing execution execution timestamp threshold. example: '2026-07-09T20:20:32.893236' trialEndDate: type: string format: date-time nullable: true description: Timestamp identifying when the free trial period lapses. example: null pauseResumesAt: type: string format: date-time nullable: true description: >- Timestamp representing when a paused schedule automatically restarts. example: null cancelAt: type: string format: date-time nullable: true description: >- Scheduled timestamp configuration for absolute future termination processing. example: null pausedAt: type: string format: date-time nullable: true description: >- Timestamp recording when the active schedule processing engine shifted states to paused. example: null cancelledAt: type: string format: date-time nullable: true description: Timestamp recording absolute terminal termination updates. example: null cancellationReason: type: string nullable: true description: >- Contextual reason string note explaining termination logging context. example: null cardExpiryAlertSent: type: boolean description: >- Indicates if an alert sequence ran concerning upcoming authorization layer structural card expiration expiration checks. example: false connectionMode: type: string description: >- The environmental testing validation infrastructure state mode tag context indicator tracking setup routing. example: Live enrollmentReference: type: string description: >- The core global billing reference signature token mapping authorized cards back safely. example: SUBREF_FF29C28B70034065A6 enrollmentTxnReference: type: string description: >- Transaction identification string mapping core setup history back to initial setup requests. example: SUB_ENROLL_21_1783539495235 chargeMode: type: string description: Operational pipeline signature processing rules template layout. example: DIRECT_CHARGE metadata: type: object nullable: true description: >- Additional user defined parameter pairs mapping details to external data schemas. example: null createdAt: type: string format: date-time description: System database initial tracking entry generation timestamp log. example: '2026-07-08T19:38:15.22973' updatedAt: type: string format: date-time description: >- System database entry transaction state revision modifier timestamp log. example: '2026-07-08T20:20:33.000927' customerBearsFee: type: boolean description: >- Identifies if transaction processing merchant cost configurations pass directly onto subscriber layer dimensions. example: false enrollConfirmed: type: boolean description: >- Confirms card setup initialization authorization completely verified with partner bank switch engines. example: true securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: Payaza {{Public API Key in Base 64}} TenantID: type: apiKey in: header name: X-TenantID description: live or test ProductID: type: apiKey in: header name: X-ProductID description: 'default value is ‟app” ' ````