FastSpring Returns API

The Returns API from FastSpring — 2 operation(s) for returns.

OpenAPI Specification

fastspring-returns-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: FastSpring Accounts Returns API
  description: REST API for FastSpring's ecommerce / merchant-of-record platform. Covers orders, subscriptions, products, coupons, accounts (customers), sessions (checkout), invoices, quotes, returns, events (webhook history), data jobs (reports), and webhook key rotation. Authenticated via HTTP Basic credentials issued from the FastSpring App Dashboard under Integrations > API Credentials. Rate limited to 250 calls per minute per IP. Requires TLS 1.2+, UTF-8 encoding, a User-Agent header, and Content-Type application/json on writes.
  version: 1.0.0
  contact:
    name: FastSpring Developer Hub
    url: https://developer.fastspring.com
servers:
- url: https://api.fastspring.com
  description: FastSpring production API
security:
- BasicAuth: []
tags:
- name: Returns
paths:
  /returns:
    post:
      tags:
      - Returns
      summary: Create a return / refund request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Return
  /returns/{return_id}:
    parameters:
    - in: path
      name: return_id
      required: true
      schema:
        type: string
    get:
      tags:
      - Returns
      summary: Retrieve a return
      responses:
        '200':
          description: Return
components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic with credentials from FastSpring App Dashboard