Klarna · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klarna HPP Captures Customer Token API

4 actions 4 updates phrasing extends openapi/klarna-customer-token-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Klarna's API. It is a proposal applied on top of the contract, not a document Klarna publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/customer-token/v1/tokens/{customerToken}'].get

$.paths['/customer-token/v1/tokens/{customerToken}/order'].post

$.paths['/customer-token/v1/tokens/{customerToken}/status'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Klarna HPP Captures Customer Token API
  version: 1.0.0
extends: openapi/klarna-customer-token-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/customer-token/v1/tokens/{customerToken}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer token's status and details
      effect: read
      questions:
      - Is a saved customer token still active, and what payment method is behind it?
      - Can I look up the payment method details stored on a customer token?
      instructions:
      - text: Get customer token {customerToken}.
        slots:
          customerToken: path.customerToken
      - text: Check the status of customer token {customerToken}.
        slots:
          customerToken: path.customerToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer-token/v1/tokens/{customerToken}/order'].post
  update:
    x-apievangelist-phrasing:
      intent: Charge a stored customer token with a new order
      effect: write
      questions:
      - How do I bill a returning subscriber using their saved Klarna token?
      - Can I auto-capture an order placed on a customer token?
      instructions:
      - text: Place an order on customer token {customerToken} for {order_amount} {purchase_currency}.
        slots:
          customerToken: path.customerToken
          order_amount: requestBody.order_amount
          purchase_currency: requestBody.purchase_currency
      - text: Charge customer token {customerToken} for cart {order_lines} with tax {order_tax_amount} and auto-capture {auto_capture}.
        slots:
          customerToken: path.customerToken
          order_lines: requestBody.order_lines
          order_tax_amount: requestBody.order_tax_amount
          auto_capture: requestBody.auto_capture
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer-token/v1/tokens/{customerToken}/status'].patch
  update:
    x-apievangelist-phrasing:
      intent: Cancel a customer token
      effect: destructive
      questions:
      - How do I stop a saved customer token from being charged again?
      - Can I change a stored token's status to cancelled when a subscription ends?
      instructions:
      - text: Set the status of customer token {customerToken} to {status}.
        slots:
          customerToken: path.customerToken
          status: requestBody.status
      - text: Cancel customer token {customerToken}.
        slots:
          customerToken: path.customerToken
      method: generated
      generated: '2026-09-26'