> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gigstack.io/llms.txt
> Use this file to discover all available pages before exploring further.

# cancel invoices portal operation

> Safe metadata only. Persist caller UUID before prepare; same immutable input can be reconciled with GET. Preparation emits no credential. Original verified grant and exact current target/mode authorize independently. Active access requires private reviewed revocation.



## OpenAPI

````yaml openapi.json DELETE /teams/{id}/invoice-portal-operations/{operationId}
openapi: 3.0.3
info:
  title: gigstack API v2
  description: >
    # gigstack API v2


    Build customer, invoice and payment integrations. Start with the
    [quickstart](https://docs.gigstack.io/quickstart), then select the [issuing
    country](https://docs.gigstack.io/concepts/shared-fields).


    ## Authentication and environments


    Use Authorization: Bearer YOUR_API_KEY. Standard live and test keys use
    https://api.gigstack.io/v2. Internal staging uses
    https://gigstack-staging-9z9nnaat.uc.gateway.dev/v2 and separate keys. Test
    mode is a data mode within an environment; a body field does not switch a
    key's mode.


    See [authentication](https://docs.gigstack.io/authentication) for key
    handling, OAuth team scope and gigstack Connect. Internal partner
    provisioning is outside this public contract; health probes have their own
    security declarations. Operations marked unavailable have no configured
    public gateway route.


    ## Read the operation contract


    Response envelopes, pagination and retry rules differ by endpoint. HTTP
    success alone does not prove external fiscal completion or movement of
    money. Reconcile ambiguous writes before retrying. Use [responses and
    recovery](https://docs.gigstack.io/responses) and the operation's error
    codes; document credits and daily limits are not generic retryable rate
    limits.


    The issuing team's configuration selects Mexico or Colombia; customer
    country and currency do not. Read
    [Mexico](https://docs.gigstack.io/countries/mexico) or
    [Colombia](https://docs.gigstack.io/countries/colombia) before choosing
    fiscal fields. Accepted public input differs from a provider's direct
    payload.


    Examples and schema checks do not imply every operation has been executed
    live. [Verification coverage](https://docs.gigstack.io/verification)
    distinguishes source review, offline checks and observed staging behavior.
    Documentation describes operations and does not authorize execution.
  version: 2.0.0
  contact:
    name: Gigstack API Support
    url: https://gigstack.io
    email: support@gigstack.io
  license:
    name: Proprietary
    url: https://gigstack.io/terms
  termsOfService: https://gigstack.io/terms
servers:
  - url: https://api.gigstack.io/v2
    description: >
      Public API for standard live and test-mode keys. Test data is isolated by
      the key mode

      (`livemode: false`). Internal staging is a separate deployment and key
      store; see

      https://docs.gigstack.io/authentication#environments for its base URL.
security:
  - bearerAuth: []
externalDocs:
  description: Complete API Documentation & Guides
  url: https://docs.gigstack.io
paths:
  /teams/{id}/invoice-portal-operations/{operationId}:
    delete:
      tags:
        - Teams
      summary: cancel invoices portal operation
      description: >-
        Safe metadata only. Persist caller UUID before prepare; same immutable
        input can be reconciled with GET. Preparation emits no credential.
        Original verified grant and exact current target/mode authorize
        independently. Active access requires private reviewed revocation.
      operationId: cancelInvoicePortalOperation
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: livemode
          in: query
          required: true
          schema:
            type: boolean
          description: >-
            Assertion only; current verified credential and browser selected
            mode must independently agree.
        - name: operationId
          in: path
          required: true
          schema:
            type: string
            format: uuid
            pattern: >-
              ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
      responses:
        '200':
          description: Confirmed operation
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/PortalAccessOperation'
        '403':
          description: Current credential, personal provenance or target authority denied
        '409':
          description: >-
            Frozen context changed, consumed proof or incompatible operation
            state
        '503':
          description: >-
            Outcome unconfirmed. Read the existing UUID; never automatically
            repeat issuance.
      security:
        - bearerAuth: []
components:
  schemas:
    PortalAccessOperation:
      type: object
      additionalProperties: false
      required:
        - operation_id
        - family
        - team_id
        - client_id
        - replaces_operation_id
        - livemode
        - status
        - created_at
        - preparation_expires_at
        - expires_at
        - access_lifetime_seconds
        - exchanged_session_lifetime_seconds
        - scopes
        - effects
        - secret_available
        - browser_handoff
        - recovery
      properties:
        operation_id:
          type: string
          format: uuid
          pattern: >-
            ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
        family:
          type: string
          enum:
            - customer
            - invoices
        team_id:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,128}$
        client_id:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,128}$
          nullable: true
        replaces_operation_id:
          type: string
          format: uuid
          pattern: >-
            ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
          nullable: true
        livemode:
          type: boolean
        status:
          type: string
          enum:
            - prepared
            - outcome_unknown
            - completed
            - cancelled
            - revoked
        created_at:
          type: integer
          minimum: 0
        preparation_expires_at:
          type: integer
          minimum: 0
        expires_at:
          type: integer
          minimum: 0
          nullable: true
        access_lifetime_seconds:
          type: integer
          minimum: 1
          maximum: 432000
          description: >-
            Customer challenge 432000 (5 days); invoice grant 1–86400 (default
            3600).
        exchanged_session_lifetime_seconds:
          type: integer
          nullable: true
          enum:
            - 259200
            - null
          description: Customer JWT 3 days; invoice family null.
        scopes:
          type: array
          items:
            type: string
            enum:
              - customer:read
              - customer:update
              - files:download
              - session:renew
              - invoices:read
        effects:
          type: array
          items:
            type: string
            enum:
              - customer_data_read
              - customer_data_update
              - invoice_receipt_payment_read
              - file_download_or_render
              - session_validation
              - invoice_read
              - invoice_file_download
        secret_available:
          type: boolean
          enum:
            - false
        browser_handoff:
          type: object
          additionalProperties: false
          required:
            - kind
            - url
          properties:
            kind:
              type: string
              enum:
                - private_browser_review
            url:
              type: string
              format: uri
              description: >-
                Opaque private browser route only; never an OTP, JWT or
                execution proof.
        recovery:
          type: string
          enum:
            - first_response_secret_not_replayed
            - read_current_operation
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        **Authentication Method:** HTTP Bearer token.


        The runtime requires the literal `Bearer ` prefix — a bare token in the

        `Authorization` header is rejected with `401 unauthorized`.


        **Header Format:** `Authorization: Bearer YOUR_API_KEY`


        Your API key is a JWT. Live keys operate on live data (`livemode:
        true`);

        test keys operate on isolated test data (`livemode: false`).


        **Get your key at:**
        [app.gigstack.pro/settings?tab=api](https://app.gigstack.pro/settings?tab=api)


        **Errors:** credential failures are answered by the authentication layer
        with a raw

        `{ "message": … }` body, not the standardized envelope — `401` for a
        missing, malformed or

        expired token, `403` for a revoked key or a plan without API access. See
        the `Unauthorized`

        and `AuthForbidden` responses.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.