nowyourlink-com Checkout Sessions API

The Checkout Sessions API from nowyourlink-com — 5 operation(s) for checkout sessions.

Operations 6

POST /checkout_sessions Create an ACP 2026-04-17 checkout for one EUR 1 metrics report #
GET /checkout_sessions/{checkout_session_id} Get metrics checkout #
POST /checkout_sessions/{checkout_session_id} Update metrics checkout #
POST /checkout_sessions/{checkout_session_id}/complete Complete metrics checkout #
POST /checkout_sessions/{checkout_session_id}/cancel Cancel metrics checkout #
GET /checkout_sessions/{checkout_session_id}/resource Get purchased metrics #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nowyourlink-com:nowyourlink-com-checkout-sessions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nowyourlink-com-checkout-sessions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nowyourlink Com Checkout Sessions API
  version: 1.0.0
  description: 'Operations tagged Checkout Sessions across 2 of this provider''s published API definitions: nowyourlink-com-openapi.json, nowyourlink-com-preview-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://nowyourlink.com
- url: https://preview.nowyourlink.com
security: []
tags:
- name: Checkout Sessions
paths:
  /checkout_sessions:
    post:
      operationId: createMetricsCheckout
      summary: Create an ACP 2026-04-17 checkout for one EUR 1 metrics report
      security:
      - agentOAuth:
        - account:read
      parameters:
      - name: API-Version
        in: header
        required: true
        schema:
          type: string
          enum:
          - '2026-04-17'
      - name: Idempotency-Key
        in: header
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - line_items
              - currency
              - capabilities
              additionalProperties: false
              properties:
                line_items:
                  type: array
                  minItems: 1
                  maxItems: 1
                  items:
                    type: object
                    required:
                    - id
                    properties:
                      id:
                        type: string
                        example: metrics:2026-09-01
                currency:
                  type: string
                  enum:
                  - eur
                capabilities:
                  type: object
            example:
              line_items:
              - id: metrics:2026-09-01
              currency: eur
              capabilities: {}
      responses:
        '200':
          description: ACP checkout state or paid metrics. No-store; owned by this OAuth grant.
        '201':
          description: Created. Follow the returned Stripe handler and merchant profile.
        '400':
          description: Invalid request or unsupported API version. See Supported-Versions.
        '401':
          description: OAuth bearer token required.
        '403':
          description: account:read scope required.
        '409':
          description: Conflicting replay, frozen cart or buyer action required.
        '503':
          description: 'Uncertain outcome: retry the same body and Idempotency-Key. Never start another payment.'
      tags:
      - Checkout Sessions
    servers:
    - url: https://nowyourlink.com
  /checkout_sessions/{checkout_session_id}:
    get:
      operationId: getMetricsCheckout
      security:
      - agentOAuth:
        - account:read
      parameters:
      - name: API-Version
        in: header
        required: true
        schema:
          type: string
          enum:
          - '2026-04-17'
      - name: checkout_session_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^cs_[a-f0-9]{32}$
      responses:
        '200':
          description: ACP checkout state or paid metrics. No-store; owned by this OAuth grant.
        '400':
          description: Invalid request or unsupported API version. See Supported-Versions.
        '401':
          description: OAuth bearer token required.
        '403':
          description: account:read scope required.
        '409':
          description: Conflicting replay, frozen cart or buyer action required.
        '503':
          description: 'Uncertain outcome: retry the same body and Idempotency-Key. Never start another payment.'
      tags:
      - Checkout Sessions
      summary: Get metrics checkout
      x-summary-source: derived
    post:
      operationId: updateMetricsCheckout
      description: Replace line_items before payment starts. Price and quantity remain EUR 1 for one report.
      security:
      - agentOAuth:
        - account:read
      parameters:
      - name: API-Version
        in: header
        required: true
        schema:
          type: string
          enum:
          - '2026-04-17'
      - name: Idempotency-Key
        in: header
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      - name: checkout_session_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^cs_[a-f0-9]{32}$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - line_items
              properties:
                line_items:
                  type: array
                  minItems: 1
                  maxItems: 1
                  items:
                    type: object
                    required:
                    - id
                    properties:
                      id:
                        type: string
                        example: metrics:2026-09-01
      responses:
        '200':
          description: ACP checkout state or paid metrics. No-store; owned by this OAuth grant.
        '400':
          description: Invalid request or unsupported API version. See Supported-Versions.
        '401':
          description: OAuth bearer token required.
        '403':
          description: account:read scope required.
        '409':
          description: Conflicting replay, frozen cart or buyer action required.
        '503':
          description: 'Uncertain outcome: retry the same body and Idempotency-Key. Never start another payment.'
      tags:
      - Checkout Sessions
      summary: Update metrics checkout
      x-summary-source: derived
    servers:
    - url: https://nowyourlink.com
  /checkout_sessions/{checkout_session_id}/complete:
    post:
      operationId: completeMetricsCheckout
      description: The buyer-approved Stripe SPT authorizes this EUR 1 charge. OAuth account:read identifies the owner only. Keep the same token, body and key when retrying uncertain outcomes.
      security:
      - agentOAuth:
        - account:read
      parameters:
      - name: API-Version
        in: header
        required: true
        schema:
          type: string
          enum:
          - '2026-04-17'
      - name: Idempotency-Key
        in: header
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      - name: checkout_session_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^cs_[a-f0-9]{32}$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - payment_data
              properties:
                payment_data:
                  type: object
                  required:
                  - handler_id
                  - instrument
                  properties:
                    handler_id:
                      type: string
                      enum:
                      - stripe
                    instrument:
                      type: object
                      required:
                      - type
                      - credential
                      properties:
                        type:
                          type: string
                          enum:
                          - card
                        credential:
                          type: object
                          required:
                          - type
                          - token
                          properties:
                            type:
                              type: string
                              enum:
                              - spt
                            token:
                              type: string
                              writeOnly: true
                              pattern: ^spt_
      responses:
        '200':
          description: ACP checkout state or paid metrics. No-store; owned by this OAuth grant.
        '400':
          description: Invalid request or unsupported API version. See Supported-Versions.
        '401':
          description: OAuth bearer token required.
        '403':
          description: account:read scope required.
        '409':
          description: Conflicting replay, frozen cart or buyer action required.
        '503':
          description: 'Uncertain outcome: retry the same body and Idempotency-Key. Never start another payment.'
      tags:
      - Checkout Sessions
      summary: Complete metrics checkout
      x-summary-source: derived
    servers:
    - url: https://nowyourlink.com
  /checkout_sessions/{checkout_session_id}/cancel:
    post:
      operationId: cancelMetricsCheckout
      description: Cancel before payment begins. Cannot cancel a payment already in progress.
      security:
      - agentOAuth:
        - account:read
      parameters:
      - name: API-Version
        in: header
        required: true
        schema:
          type: string
          enum:
          - '2026-04-17'
      - name: Idempotency-Key
        in: header
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
      - name: checkout_session_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^cs_[a-f0-9]{32}$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              maxProperties: 0
      responses:
        '200':
          description: ACP checkout state or paid metrics. No-store; owned by this OAuth grant.
        '400':
          description: Invalid request or unsupported API version. See Supported-Versions.
        '401':
          description: OAuth bearer token required.
        '403':
          description: account:read scope required.
        '409':
          description: Conflicting replay, frozen cart or buyer action required.
        '503':
          description: 'Uncertain outcome: retry the same body and Idempotency-Key. Never start another payment.'
      tags:
      - Checkout Sessions
      summary: Cancel metrics checkout
      x-summary-source: derived
    servers:
    - url: https://nowyourlink.com
  /checkout_sessions/{checkout_session_id}/resource:
    get:
      operationId: getPurchasedMetrics
      description: Retrieve the report after confirmed payment, using the same OAuth grant.
      security:
      - agentOAuth:
        - account:read
      parameters:
      - name: API-Version
        in: header
        required: true
        schema:
          type: string
          enum:
          - '2026-04-17'
      - name: checkout_session_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^cs_[a-f0-9]{32}$
      responses:
        '200':
          description: ACP checkout state or paid metrics. No-store; owned by this OAuth grant.
        '400':
          description: Invalid request or unsupported API version. See Supported-Versions.
        '401':
          description: OAuth bearer token required.
        '403':
          description: account:read scope required.
        '409':
          description: Conflicting replay, frozen cart or buyer action required.
        '503':
          description: 'Uncertain outcome: retry the same body and Idempotency-Key. Never start another payment.'
      tags:
      - Checkout Sessions
      summary: Get purchased metrics
      x-summary-source: derived
    servers:
    - url: https://nowyourlink.com
components:
  securitySchemes:
    affiliateSession:
      type: apiKey
      in: cookie
      name: nyl_sess
      description: Signed-in user session. State changes require the website Origin. Preview uses nyl_sess_preview.
    agentOAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://api.nowyourlink.com/oauth/authorize
          tokenUrl: https://api.nowyourlink.com/oauth/token
          refreshUrl: https://api.nowyourlink.com/oauth/token
          scopes:
            account:read: Read account, settings and eligibility
            account:write: Update eligible company details and contact preferences
            reports:read: Read your campaign reports and Spotlight performance
            bids:read: Read own bids
            bids:write: Place and raise bids within the mandate
            creatives:read: Read own creatives
            creatives:write: Upload and submit creatives
            invoices:read: Read invoices
            billing:read: Read your saved payment methods
            billing:write: Manage your saved payment methods and billing portal
            security:read: Read your registered passkeys
            security:write: Remove your registered passkeys
            privacy:write: Request data export or account erasure
            connections:read: Read your authorized agent connections
            connections:write: Revoke your authorized agent connections
            affiliate:read: Read own partner statistics, referral links and payouts
            affiliate:write: Configure own callback and request commission payouts
x-refined-from:
- nowyourlink-com-openapi.json
- nowyourlink-com-preview-openapi.json