> ## Documentation Index > Fetch the complete documentation index at: https://api-reference.hyperswitch.io/llms.txt > Use this file to discover all available pages before exploring further. # Subscription - Get Estimate > Gets pricing estimate for a subscription. ## OpenAPI ````yaml get /subscriptions/estimate openapi: 3.0.3 info: title: Hyperswitch - API Documentation description: > ## Get started Hyperswitch provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. You can consume the APIs directly using your favorite HTTP/REST library. We have a testing environment referred to "sandbox", which you can setup to test API calls without affecting production data. Currently, our sandbox environment is live while our production environment is under development and will be available soon. You can sign up on our Dashboard to get API keys to access Hyperswitch API. ### Environment Use the following base URLs when making requests to the APIs: | Environment | Base URL | |---------------|------------------------------------| | Sandbox | | | Production | | ## Authentication When you sign up on our [dashboard](https://app.hyperswitch.io) and create a merchant account, you are given a secret key (also referred as api-key) and a publishable key. You may authenticate all API requests with Hyperswitch server by providing the appropriate key in the request Authorization header. | Key | Description | |-----------------|-----------------------------------------------------------------------------------------------| | api-key | Private key. Used to authenticate all API requests from your merchant server | | publishable key | Unique identifier for your account. Used to authenticate API requests from your app's client | Never share your secret api keys. Keep them guarded and secure. contact: name: Hyperswitch Support url: https://hyperswitch.io email: support.global@juspay.io license: name: Apache-2.0 version: 0.1.0 servers: - url: https://sandbox.hyperswitch.io description: Sandbox Environment security: [] tags: - name: Merchant Account description: Create and manage merchant accounts - name: Profile description: Create and manage profiles - name: Merchant Connector Account description: Create and manage merchant connector accounts - name: Payments description: Create and manage one-time payments, recurring payments and mandates - name: Refunds description: Create and manage refunds for successful payments - name: Mandates description: Manage mandates - name: Customers description: Create and manage customers - name: Payment Methods description: Create and manage payment methods of customers - name: Disputes description: Manage disputes - name: API Key description: Create and manage API Keys - name: Payouts description: Create and manage payouts - name: payment link description: Create payment link - name: Routing description: Create and manage routing configurations - name: Event description: Manage events - name: Authentication description: Create and manage authentication - name: Subscriptions description: Subscription management and billing endpoints - name: Card Issuer description: Create and manage card issuers paths: /subscriptions/estimate: get: tags: - Subscriptions summary: Subscription - Get Estimate description: Gets pricing estimate for a subscription. operationId: Get Subscription Estimate parameters: - name: X-Profile-Id in: header description: Profile ID for authentication required: true schema: type: string - name: plan_id in: query description: Plan ID for estimation required: true schema: type: string - name: customer_id in: query description: Customer ID for personalized pricing required: false schema: type: string nullable: true - name: coupon_id in: query description: Coupon ID to apply discount required: false schema: type: string nullable: true - name: trial_days in: query description: Number of trial days required: false schema: type: integer format: int32 nullable: true minimum: 0 responses: '200': description: Estimate retrieved successfully content: application/json: schema: $ref: '#/components/schemas/EstimateSubscriptionResponse' '400': description: Invalid estimation parameters '404': description: Plan not found security: - api_key: [] components: schemas: EstimateSubscriptionResponse: type: object required: - amount - currency - line_items properties: amount: $ref: '#/components/schemas/MinorUnit' currency: $ref: '#/components/schemas/Currency' plan_id: type: string description: Identifier for the associated plan_id. nullable: true item_price_id: type: string description: Identifier for the associated item_price_id for the subscription. nullable: true coupon_code: type: string description: Identifier for the coupon code for the subscription. nullable: true customer_id: allOf: - $ref: '#/components/schemas/CustomerId' nullable: true line_items: type: array items: $ref: '#/components/schemas/SubscriptionLineItem' MinorUnit: type: integer format: int64 description: This Unit struct represents MinorUnit in which core amount works Currency: type: string description: >- The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment. enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STD - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL CustomerId: type: string description: A type for customer_id that can be used for customer ids SubscriptionLineItem: type: object required: - item_id - item_type - description - amount - currency - quantity properties: item_id: type: string description: Unique identifier for the line item. item_type: type: string description: Type of the line item. description: type: string description: Description of the line item. amount: $ref: '#/components/schemas/MinorUnit' currency: $ref: '#/components/schemas/Currency' quantity: type: integer format: int64 description: Quantity of the line item. securitySchemes: api_key: type: apiKey in: header name: api-key description: >- Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application. ````