Stripe Credit Notes API — Credit

naftiko: 1.0.0-alpha2
info:
  label: Stripe Credit Notes API — Credit
  description: 'Stripe Credit Notes API — Credit. 8 operations. Lead operation: Stripe Get   Credit Notes. Self-contained
    Naftiko capability covering one Stripe business surface.'
  tags:
  - Stripe
  - Credit
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STRIPE_API_KEY: STRIPE_API_KEY
capability:
  consumes:
  - type: http
    namespace: credit-notes-credit
    baseUri: https://api.stripe.com
    description: Stripe Credit Notes API — Credit business capability. Self-contained, no shared references.
    resources:
    - name: v1-credit_notes
      path: /v1/credit_notes
      operations:
      - name: getcreditnotes
        method: GET
        description: Stripe Get   Credit Notes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: query
          type: string
          description: Only return credit notes for the customer specified by this customer ID.
        - name: ending_before
          in: query
          type: string
          description: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 ob
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: invoice
          in: query
          type: string
          description: Only return credit notes for the invoice specified by this invoice ID.
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 10.
        - name: starting_after
          in: query
          type: string
          description: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 o
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: postcreditnotes
        method: POST
        description: Stripe Post   Credit Notes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-credit_notes-preview
      path: /v1/credit_notes/preview
      operations:
      - name: getcreditnotespreview
        method: GET
        description: Stripe Get   Credit Notes Preview
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: amount
          in: query
          type: integer
          description: The integer amount in cents (or local equivalent) representing the total amount of the credit note.
        - name: credit_amount
          in: query
          type: integer
          description: The integer amount in cents (or local equivalent) representing the amount to credit the customer's
            balance, which will be automatically applied to their next in
        - name: effective_at
          in: query
          type: integer
          description: The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this
            value replaces the system-generated 'Date of issue' printe
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: invoice
          in: query
          type: string
          description: ID of the invoice.
          required: true
        - name: lines
          in: query
          type: array
          description: Line items that make up the credit note.
        - name: memo
          in: query
          type: string
          description: The credit note's memo appears on the credit note PDF.
        - name: metadata
          in: query
          type: object
          description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This
            can be useful for storing additional information about the
        - name: out_of_band_amount
          in: query
          type: integer
          description: The integer amount in cents (or local equivalent) representing the amount that is credited outside
            of Stripe.
        - name: reason
          in: query
          type: string
          description: Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
        - name: refund
          in: query
          type: string
          description: ID of an existing refund to link this credit note to.
        - name: refund_amount
          in: query
          type: integer
          description: The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund
            will be created for the charge associated with the invoice
        - name: shipping_cost
          in: query
          type: object
          description: When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the
            credit note.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-credit_notes-preview-lines
      path: /v1/credit_notes/preview/lines
      operations:
      - name: getcreditnotespreviewlines
        method: GET
        description: Stripe Get   Credit Notes Preview Lines
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: amount
          in: query
          type: integer
          description: The integer amount in cents (or local equivalent) representing the total amount of the credit note.
        - name: credit_amount
          in: query
          type: integer
          description: The integer amount in cents (or local equivalent) representing the amount to credit the customer's
            balance, which will be automatically applied to their next in
        - name: effective_at
          in: query
          type: integer
          description: The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this
            value replaces the system-generated 'Date of issue' printe
        - name: ending_before
          in: query
          type: string
          description: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 ob
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: invoice
          in: query
          type: string
          description: ID of the invoice.
          required: true
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 10.
        - name: lines
          in: query
          type: array
          description: Line items that make up the credit note.
        - name: memo
          in: query
          type: string
          description: The credit note's memo appears on the credit note PDF.
        - name: metadata
          in: query
          type: object
          description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This
            can be useful for storing additional information about the
        - name: out_of_band_amount
          in: query
          type: integer
          description: The integer amount in cents (or local equivalent) representing the amount that is credited outside
            of Stripe.
        - name: reason
          in: query
          type: string
          description: Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
        - name: refund
          in: query
          type: string
          description: ID of an existing refund to link this credit note to.
        - name: refund_amount
          in: query
          type: integer
          description: The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund
            will be created for the charge associated with the invoice
        - name: shipping_cost
          in: query
          type: object
          description: When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the
            credit note.
        - name: starting_after
          in: query
          type: string
          description: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 o
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-credit_notes-credit_note-lines
      path: /v1/credit_notes/{credit_note}/lines
      operations:
      - name: getcreditnotescreditnotelines
        method: GET
        description: Stripe Get   Credit Notes Credit Note Lines
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: credit_note
          in: path
          type: string
          required: true
        - name: ending_before
          in: query
          type: string
          description: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 ob
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 10.
        - name: starting_after
          in: query
          type: string
          description: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 o
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-credit_notes-id
      path: /v1/credit_notes/{id}
      operations:
      - name: getcreditnotesid
        method: GET
        description: Stripe Get   Credit Notes Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: postcreditnotesid
        method: POST
        description: Stripe Post   Credit Notes Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-credit_notes-id-void
      path: /v1/credit_notes/{id}/void
      operations:
      - name: postcreditnotesidvoid
        method: POST
        description: Stripe Post   Credit Notes Id Void
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.STRIPE_API_KEY}}'
  exposes:
  - type: rest
    namespace: credit-notes-credit-rest
    port: 8080
    description: REST adapter for Stripe Credit Notes API — Credit. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/credit-notes
      name: v1-credit-notes
      description: REST surface for v1-credit_notes.
      operations:
      - method: GET
        name: getcreditnotes
        description: Stripe Get   Credit Notes
        call: credit-notes-credit.getcreditnotes
        with:
          customer: rest.customer
          ending_before: rest.ending_before
          expand: rest.expand
          invoice: rest.invoice
          limit: rest.limit
          starting_after: rest.starting_after
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postcreditnotes
        description: Stripe Post   Credit Notes
        call: credit-notes-credit.postcreditnotes
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/credit-notes/preview
      name: v1-credit-notes-preview
      description: REST surface for v1-credit_notes-preview.
      operations:
      - method: GET
        name: getcreditnotespreview
        description: Stripe Get   Credit Notes Preview
        call: credit-notes-credit.getcreditnotespreview
        with:
          amount: rest.amount
          credit_amount: rest.credit_amount
          effective_at: rest.effective_at
          expand: rest.expand
          invoice: rest.invoice
          lines: rest.lines
          memo: rest.memo
          metadata: rest.metadata
          out_of_band_amount: rest.out_of_band_amount
          reason: rest.reason
          refund: rest.refund
          refund_amount: rest.refund_amount
          shipping_cost: rest.shipping_cost
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/credit-notes/preview/lines
      name: v1-credit-notes-preview-lines
      description: REST surface for v1-credit_notes-preview-lines.
      operations:
      - method: GET
        name: getcreditnotespreviewlines
        description: Stripe Get   Credit Notes Preview Lines
        call: credit-notes-credit.getcreditnotespreviewlines
        with:
          amount: rest.amount
          credit_amount: rest.credit_amount
          effective_at: rest.effective_at
          ending_before: rest.ending_before
          expand: rest.expand
          invoice: rest.invoice
          limit: rest.limit
          lines: rest.lines
          memo: rest.memo
          metadata: rest.metadata
          out_of_band_amount: rest.out_of_band_amount
          reason: rest.reason
          refund: rest.refund
          refund_amount: rest.refund_amount
          shipping_cost: rest.shipping_cost
          starting_after: rest.starting_after
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/credit-notes/{credit-note}/lines
      name: v1-credit-notes-credit-note-lines
      description: REST surface for v1-credit_notes-credit_note-lines.
      operations:
      - method: GET
        name: getcreditnotescreditnotelines
        description: Stripe Get   Credit Notes Credit Note Lines
        call: credit-notes-credit.getcreditnotescreditnotelines
        with:
          credit_note: rest.credit_note
          ending_before: rest.ending_before
          expand: rest.expand
          limit: rest.limit
          starting_after: rest.starting_after
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/credit-notes/{id}
      name: v1-credit-notes-id
      description: REST surface for v1-credit_notes-id.
      operations:
      - method: GET
        name: getcreditnotesid
        description: Stripe Get   Credit Notes Id
        call: credit-notes-credit.getcreditnotesid
        with:
          expand: rest.expand
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postcreditnotesid
        description: Stripe Post   Credit Notes Id
        call: credit-notes-credit.postcreditnotesid
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/credit-notes/{id}/void
      name: v1-credit-notes-id-void
      description: REST surface for v1-credit_notes-id-void.
      operations:
      - method: POST
        name: postcreditnotesidvoid
        description: Stripe Post   Credit Notes Id Void
        call: credit-notes-credit.postcreditnotesidvoid
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: credit-notes-credit-mcp
    port: 9090
    transport: http
    description: MCP adapter for Stripe Credit Notes API — Credit. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: stripe-get-credit-notes
      description: Stripe Get   Credit Notes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: credit-notes-credit.getcreditnotes
      with:
        customer: tools.customer
        ending_before: tools.ending_before
        expand: tools.expand
        invoice: tools.invoice
        limit: tools.limit
        starting_after: tools.starting_after
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: stripe-post-credit-notes
      description: Stripe Post   Credit Notes
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: credit-notes-credit.postcreditnotes
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: stripe-get-credit-notes-preview
      description: Stripe Get   Credit Notes Preview
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: credit-notes-credit.getcreditnotespreview
      with:
        amount: tools.amount
        credit_amount: tools.credit_amount
        effective_at: tools.effective_at
        expand: tools.expand
        invoice: tools.invoice
        lines: tools.lines
        memo: tools.memo
        metadata: tools.metadata
        out_of_band_amount: tools.out_of_band_amount
        reason: tools.reason
        refund: tools.refund
        refund_amount: tools.refund_amount
        shipping_cost: tools.shipping_cost
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: stripe-get-credit-notes-preview-2
      description: Stripe Get   Credit Notes Preview Lines
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: credit-notes-credit.getcreditnotespreviewlines
      with:
        amount: tools.amount
        credit_amount: tools.credit_amount
        effective_at: tools.effective_at
        ending_before: tools.ending_before
        expand: tools.expand
        invoice: tools.invoice
        limit: tools.limit
        lines: tools.lines
        memo: tools.memo
        metadata: tools.metadata
        out_of_band_amount: tools.out_of_band_amount
        reason: tools.reason
        refund: tools.refund
        refund_amount: tools.refund_amount
        shipping_cost: tools.shipping_cost
        starting_after: tools.starting_after
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: stripe-get-credit-notes-credit
      description: Stripe Get   Credit Notes Credit Note Lines
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: credit-notes-credit.getcreditnotescreditnotelines
      with:
        credit_note: tools.credit_note
        ending_before: tools.ending_before
        expand: tools.expand
        limit: tools.limit
        starting_after: tools.starting_after
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: stripe-get-credit-notes-id
      description: Stripe Get   Credit Notes Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: credit-notes-credit.getcreditnotesid
      with:
        expand: tools.expand
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: stripe-post-credit-notes-id
      description: Stripe Post   Credit Notes Id
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: credit-notes-credit.postcreditnotesid
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: stripe-post-credit-notes-id-2
      description: Stripe Post   Credit Notes Id Void
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: credit-notes-credit.postcreditnotesidvoid
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.