> ## Documentation Index > Fetch the complete documentation index at: https://docs.oms.verolabs.co/llms.txt > Use this file to discover all available pages before exploring further. # Subscribe to a right offering > Subscribe to a right offering ## OpenAPI ````yaml openapi.docs.en.json POST /api/v1/users/right-subscriptions openapi: 3.0.3 info: title: Vero OMS REST API version: 1.0.24 description: >- REST API documentation for Vero OMS. Paths are aligned with the active KrakenD gateway config under k8s-dev-gitops/vero-algo/tools/krakend and response schemas are expanded from backend/frontend source models. servers: - url: https://api-gw.verolabs.co description: API gateway security: [] tags: - name: Auth description: Authentication flows and app logout - name: Signup description: APIs used during account signup - name: Accounts description: User accounts, balances, positions, deposits and withdrawals - name: Bank Accounts description: Saved bank account management - name: Orders description: Order placement, cancellation, modification and order history - name: History description: Account orders, trades and cash transactions. - name: Market Data description: Watchlists, symbol search, product master and OHLCV history - name: Notifications description: In-app notifications - name: Referral description: Referral code, rebate and commission summary APIs - name: Diagnostics description: Health and diagnostic endpoints paths: /api/v1/users/right-subscriptions: post: tags: - Accounts summary: Subscribe to a right offering description: Subscribe to a right offering. operationId: subscribeRight requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SubscribeRightRequest' description: Right subscription request payload. symbol and shares are required. responses: '200': description: Submitted right subscription request. content: application/json: schema: $ref: '#/components/schemas/SubscribeRightResponse' '400': $ref: '#/components/responses/ErrorResponse' description: Error response. content: application/json: schema: $ref: '#/components/schemas/AnyErrorBody' application/problem+json: schema: oneOf: - $ref: '#/components/schemas/ValidationProblemDetails' - $ref: '#/components/schemas/ProblemDetails' text/plain: schema: type: string description: Plain-text backend or gateway error message. '401': $ref: '#/components/responses/ErrorResponse' description: Error response. content: application/json: schema: $ref: '#/components/schemas/AnyErrorBody' application/problem+json: schema: oneOf: - $ref: '#/components/schemas/ValidationProblemDetails' - $ref: '#/components/schemas/ProblemDetails' text/plain: schema: type: string description: Plain-text backend or gateway error message. '404': $ref: '#/components/responses/ErrorResponse' description: Error response. content: application/json: schema: $ref: '#/components/schemas/AnyErrorBody' application/problem+json: schema: oneOf: - $ref: '#/components/schemas/ValidationProblemDetails' - $ref: '#/components/schemas/ProblemDetails' text/plain: schema: type: string description: Plain-text backend or gateway error message. '500': $ref: '#/components/responses/ErrorResponse' description: Error response. content: application/json: schema: $ref: '#/components/schemas/AnyErrorBody' application/problem+json: schema: oneOf: - $ref: '#/components/schemas/ValidationProblemDetails' - $ref: '#/components/schemas/ProblemDetails' text/plain: schema: type: string description: Plain-text backend or gateway error message. security: - bearerAuth: [] components: schemas: SubscribeRightRequest: type: object additionalProperties: false description: Payload for submitting a right subscription request. required: - symbol - shares properties: symbol: type: string description: Symbol to subscribe. shares: type: integer minimum: 1 description: Number of new shares to subscribe. SubscribeRightResponse: type: object additionalProperties: true description: Response returned after submitting a right subscription request. properties: status: type: string description: success or failed. message: type: string description: Human-readable result. subscription: $ref: '#/components/schemas/UserRightSubscription' heldAmount: type: number description: Credit amount held by the backend. AnyErrorBody: oneOf: - $ref: '#/components/schemas/ErrorResponse' - $ref: '#/components/schemas/ValidationProblemDetails' - $ref: '#/components/schemas/ProblemDetails' - $ref: '#/components/schemas/AuthFlow' description: >- Structured error body returned by gateway, ASP.NET services, or backend validation handlers. ValidationProblemDetails: allOf: - $ref: '#/components/schemas/ProblemDetails' - type: object additionalProperties: true properties: errors: type: object additionalProperties: oneOf: - type: array items: type: string - type: string description: Validation errors keyed by request field name. description: >- Validation problem response returned when request parameters or body fields are invalid. ProblemDetails: type: object additionalProperties: true description: RFC 7807-style problem response returned by ASP.NET/gateway services. properties: type: type: string description: Problem type URI. title: type: string description: Short problem title. status: type: integer description: HTTP status code. detail: type: string description: Detailed error message. traceId: type: string description: Trace id for backend diagnostics. UserRightSubscription: type: object additionalProperties: true description: Right subscription request/entitlement for one account. properties: id: type: integer format: int64 description: User subscription id. accountId: type: string description: Account eligible for the right subscription. ruleId: type: integer format: int64 description: Source right subscription rule id. symbol: type: string description: Subscribed symbol. eligibleShares: type: integer format: int64 description: Shares held or eligible for the entitlement. maxNewShares: type: integer format: int64 description: Maximum new shares that can be subscribed. subscribedShares: type: integer format: int64 description: Shares requested by the user. remainingShares: type: integer format: int64 description: Remaining shares that can still be subscribed. price: type: number description: Subscription price per share. heldAmount: type: number description: Credit amount held for pending subscription. status: type: string enum: - pending - approved - rejected - expired description: Subscription request status. rejectReason: type: string description: Reason when rejected. endDate: type: string format: date description: Subscription end date. createdAt: type: string format: date-time description: Creation timestamp. updatedAt: type: string format: date-time nullable: true description: Last update timestamp. ErrorResponse: type: object additionalProperties: true description: >- Error body returned by gateway or backend services. Backends can return either JSON objects or plain text errors. properties: error: oneOf: - type: string - type: object additionalProperties: true properties: id: type: string description: gateway error id when supplied. code: type: integer description: HTTP-like error code. status: type: string description: HTTP status text, for example Unauthorized. reason: type: string description: >- Detailed reason returned by the authentication service or gateway. message: type: string description: Human-readable error message. description: Error code/message string or nested gateway error object. message: type: string description: Human-readable error message. detail: type: string description: Detailed backend error message when available. details: oneOf: - type: string - type: object additionalProperties: true - type: array items: type: object additionalProperties: true description: Additional validation or backend details. nullable: true status: type: integer description: HTTP status code when included by the backend. AuthFlow: type: object additionalProperties: true properties: id: type: string description: >- Flow id. Use this value as the flow query parameter when submitting or updating the flow. type: type: string description: Flow type returned by the system, for example browser or api. expires_at: type: string format: date-time description: Timestamp when the flow expires. Submit the flow before this time. issued_at: type: string format: date-time description: Timestamp when created the flow. ui: type: object additionalProperties: true description: >- UI payload containing action URL, method, nodes, messages, and CSRF node when required. state: type: string description: >- Current flow state, such as choose_method, sent_email, passed_challenge, or success. request_url: type: string description: Original request URL used to create the flow. organization_id: type: string nullable: true description: organization id for organization-scoped flows, when supplied. created_at: type: string description: Flow creation timestamp. format: date-time updated_at: type: string description: Flow update timestamp. format: date-time refresh: type: boolean description: Whether the flow is a refresh flow. requested_aal: type: string description: Requested authenticator assurance level for the flow. identity: allOf: - 9cb587e8-c15a-435c-916a-4854d0ffa2c6 description: Identity attached to settings flows when the system includes it. description: >- self-service flow object returned by login, registration, recovery, and settings create/update endpoints. responses: ErrorResponse: description: Error response containing an error code, message, detail, or plain text. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' text/plain: schema: type: string securitySchemes: bearerAuth: type: http scheme: bearer description: Bearer token used for protected REST API requests. ````