> ## 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. # Change Plan > This changes the subscription to another pricing plan either immediately or at the next billing cycle. **Notes:** - `effective` defaults to **NEXT_CYCLE** if not supplied. - When `effective` is **NEXT_CYCLE**, the new plan is stored as the pending plan and becomes active at the next successful billing cycle. - When `effective` is **IMMEDIATELY**, the subscription is switched to the new plan immediately. - Attempting to change to the current plan or modifying a terminal subscription returns a validation error. ## OpenAPI ````yaml /openapi.json post /subscription/api/v1/subscriptions/{id}/change-plan 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}/change-plan: post: tags: - Subscription Lifecycle summary: Change Plan description: >- This changes the subscription to another pricing plan either immediately or at the next billing cycle. **Notes:** - `effective` defaults to **NEXT_CYCLE** if not supplied. - When `effective` is **NEXT_CYCLE**, the new plan is stored as the pending plan and becomes active at the next successful billing cycle. - When `effective` is **IMMEDIATELY**, the subscription is switched to the new plan immediately. - Attempting to change to the current plan or modifying a terminal subscription returns a validation error. parameters: - name: id in: path required: true schema: type: string description: The ID of the subscription. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/changeSubscriptionPlanRequest' examples: Change Subscription Plan: summary: Change Subscription Plan value: newPlanCode: PLAN-XY99ZZ00 effective: NEXT_CYCLE prorate: true responses: '200': description: Request Successful content: application/json: schema: $ref: 98305cd5-7e51-4fe7-8014-9a0b40711e19 examples: Change Subscription Plan: summary: Change Subscription Plan value: success: true message: Plan change scheduled data: id: 3 status: ACTIVE pendingPlanId: 8 nextChargeDate: '2026-07-30T10:00:00' '400': description: Invalid request security: - ApiKeyAuth: - Payaza {{Public API Key In Base64}} components: schemas: changeSubscriptionPlanRequest: title: Change Subscription Plan Request type: object required: - newPlanCode properties: newPlanCode: type: string description: The plan code of the new subscription plan. example: PLAN-XY99ZZ00 effective: type: string description: >- When the new plan should take effect. Supported values are **IMMEDIATELY** and **NEXT_CYCLE**. example: NEXT_CYCLE prorate: type: boolean description: Indicates whether the current billing cycle should be prorated. 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” ' ````