> ## Documentation Index > Fetch the complete documentation index at: https://docs.ecrypt.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Subscription > Get the specified subscription. ## OpenAPI ````yaml swagger-001.json GET /v1/subscriptions/{Subscription} openapi: 3.0.4 info: title: Ecrypt API description: Ecrypt API termsOfService: https://ecrypt.com contact: name: Dev Support url: https://developer.ecrypt.com email: devsupport@ecrypt.com version: v1 servers: - url: https://api.ecrypt.com description: Live security: - x-api-key: [] paths: /v1/subscriptions/{Subscription}: get: tags: - Subscriptions summary: Get Subscription description: Get the specified subscription. parameters: - name: Subscription in: path description: '`Subscription` is the Ecrypt subscription identifier.' required: true schema: maxLength: 64 minLength: 8 pattern: ^[0-9A-Za-z-]*$ type: string default: 00000000-0000-0000-0000-000000000000 responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/Ecrypt.Gateway.Api.Core.Model.Subscriptions.SubscriptionGetResponse '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Ecrypt.Gateway.Api.Core.Model.BadRequest' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '429': description: Too Many Requests components: schemas: Ecrypt.Gateway.Api.Core.Model.Subscriptions.SubscriptionGetResponse: required: - requestId type: object properties: subscriptions: type: array items: $ref: >- #/components/schemas/Ecrypt.Gateway.Api.Core.Model.Subscriptions.Subscription nullable: true requestId: maxLength: 100 minLength: 1 type: string default: '000000000000000000000' errors: type: array items: $ref: >- #/components/schemas/Ecrypt.Gateway.Api.Core.Model.ResponseBaseError nullable: true additionalProperties: false nullable: true Ecrypt.Gateway.Api.Core.Model.BadRequest: required: - requestId type: object properties: errors: type: array items: $ref: '#/components/schemas/Ecrypt.Gateway.Api.Core.Model.BadRequestError' nullable: true requestId: maxLength: 100 minLength: 1 type: string default: '000000000000000000000' additionalProperties: false nullable: true Ecrypt.Gateway.Api.Core.Model.Subscriptions.Subscription: required: - amount - cycle - id - label type: object properties: id: minLength: 1 type: string label: maxLength: 100 minLength: 1 pattern: ^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$ type: string cycle: $ref: >- #/components/schemas/Ecrypt.Gateway.Api.Core.Model.Subscriptions.SubscriptionCycle amount: $ref: >- #/components/schemas/Ecrypt.Gateway.Api.Core.Model.Transactions.Amount installments: maximum: 2147483647 minimum: 0 type: integer description: Number of installments to run at the specified unit, and interval format: int32 nullable: true additionalProperties: false nullable: true Ecrypt.Gateway.Api.Core.Model.ResponseBaseError: type: object properties: type: type: string message: {} additionalProperties: false nullable: true Ecrypt.Gateway.Api.Core.Model.BadRequestError: type: object properties: type: type: string message: {} additionalProperties: false nullable: true Ecrypt.Gateway.Api.Core.Model.Subscriptions.SubscriptionCycle: type: object properties: unit: type: string description: "Unit for cycle\r\n***Supported Units***\r\n- `day`\r\n- `week`\r\n- `month`\r\n- `year`" default: month interval: type: integer description: "Interval for cycle\r\n***Supported Units***\r\n- `day, 1-365, 1 == Daily, 2 = every second day, 7 == once a week`\r\n- `week, 1-52, 1 == Every Week, 2 = every other week, will default to charge on Monday if no other Day of Cycle is not specified`\r\n- `Month, 1-12, 1== every month, 2 = every other month, will default to the day the subscription became active if day of cycle is not specified`\r\n- `Year, 1-500, 1== every year`" format: int32 default: 1 dayOfCycle: type: integer description: "Day of cycle for the specified unit\r\n***Supported Units***\r\n- `day, not supported`\r\n- `week, 1-7, 1= monday 7 = sunday`\r\n- `month 1-31, if 31 is specified it will default to the last day of the month for all months with less that 31 days`\r\n- `year 1-365, any day in the year`" format: int32 default: 1 additionalProperties: false nullable: true Ecrypt.Gateway.Api.Core.Model.Transactions.Amount: required: - value type: object properties: currency: allOf: - $ref: >- #/components/schemas/Ecrypt.Gateway.Api.Core.Model.WebAPI.Enums.CurrencyCode nullable: true value: maximum: 999999999.99 minimum: 0.01 type: number description: "Values is the full amount to be processed. The value is inclusive of all tax, discounts, shipping, fees ect.\r\n\r\nExample: 127.55" format: decimal additionalProperties: false nullable: true Ecrypt.Gateway.Api.Core.Model.WebAPI.Enums.CurrencyCode: enum: - 8 - 12 - 32 - 36 - 44 - 48 - 50 - 51 - 52 - 60 - 64 - 68 - 72 - 84 - 90 - 96 - 104 - 108 - 116 - 124 - 132 - 136 - 144 - 152 - 156 - 170 - 174 - 188 - 192 - 203 - 208 - 214 - 222 - 230 - 232 - 238 - 242 - 262 - 270 - 292 - 320 - 324 - 328 - 332 - 340 - 344 - 348 - 352 - 356 - 360 - 364 - 368 - 376 - 388 - 392 - 398 - 400 - 404 - 408 - 410 - 414 - 417 - 418 - 422 - 426 - 430 - 434 - 446 - 454 - 458 - 462 - 480 - 484 - 496 - 498 - 504 - 512 - 516 - 524 - 532 - 533 - 548 - 554 - 558 - 566 - 578 - 586 - 590 - 598 - 600 - 604 - 608 - 634 - 643 - 646 - 654 - 682 - 690 - 702 - 704 - 706 - 710 - 728 - 748 - 752 - 756 - 760 - 764 - 776 - 780 - 784 - 788 - 800 - 807 - 818 - 826 - 834 - 840 - 858 - 860 - 882 - 886 - 901 - 925 - 926 - 929 - 930 - 931 - 932 - 933 - 934 - 936 - 937 - 938 - 940 - 941 - 943 - 944 - 946 - 947 - 948 - 949 - 950 - 951 - 952 - 953 - 960 - 965 - 967 - 968 - 969 - 970 - 971 - 972 - 973 - 975 - 976 - 977 - 978 - 979 - 980 - 981 - 984 - 985 - 986 - 990 - 994 - 997 type: integer format: int32 x-enumNames: - ALL - DZD - ARS - AUD - BSD - BHD - BDT - AMD - BBD - BMD - BTN - BOB - BWP - BZD - SBD - BND - MMK - BIF - KHR - CAD - CVE - KYD - LKR - CLP - CNY - COP - KMF - CRC - CUP - CZK - DKK - DOP - SVC - ETB - ERN - FKP - FJD - DJF - GMD - GIP - GTQ - GNF - GYD - HTG - HNL - HKD - HUF - ISK - INR - IDR - IRR - IQD - ILS - JMD - JPY - KZT - JOD - KES - KPW - KRW - KWD - KGS - LAK - LBP - LSL - LRD - LYD - MOP - MWK - MYR - MVR - MUR - MXN - MNT - MDL - MAD - OMR - NAD - NPR - ANG - AWG - VUV - NZD - NIO - NGN - NOK - PKR - PAB - PGK - PYG - PEN - PHP - QAR - RUB - RWF - SHP - SAR - SCR - SGD - VND - SOS - ZAR - SSP - SZL - SEK - CHF - SYP - THB - TOP - TTD - AED - TND - UGX - MKD - EGP - GBP - TZS - USD - UYU - UZS - WST - YER - TWD - SLE - VED - MRU - STN - CUC - ZWL - BYN - TMT - GHS - VEF - SDG - UYI - RSD - MZN - AZN - RON - CHE - CHW - TRY - XAF - XCD - XOF - XPF - XDR - XUA - ZMW - SRD - MGA - COU - AFN - TJS - AOA - BGN - CDF - BAM - EUR - MXV - UAH - GEL - BOV - PLN - BRL - CLF - XSU - USN securitySchemes: x-api-key: type: apiKey description: Authorization by x-api-key inside request's header name: x-api-key in: header ````