FastSpring

opencollection: 1.0.0
info:
  name: FastSpring API
  version: 1.0.0
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Accounts
    type: folder
  items:
  - info:
      name: List accounts
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/accounts
    docs: List accounts
  - info:
      name: Create an account
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/accounts
      body:
        type: json
        data: '{}'
    docs: Create an account
  - info:
      name: Retrieve an account
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/accounts/:account_id
      params:
      - name: account_id
        value: ''
        type: path
    docs: Retrieve an account
  - info:
      name: Update an account
      type: http
    http:
      method: PATCH
      url: https://api.fastspring.com/accounts/:account_id
      params:
      - name: account_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update an account
  - info:
      name: Get an account's management portal URL
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/accounts/:account_id/portal-url
      params:
      - name: account_id
        value: ''
        type: path
    docs: Get an account's management portal URL
- info:
    name: Coupons
    type: folder
  items:
  - info:
      name: List coupon identifiers
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/coupons
    docs: List coupon identifiers
  - info:
      name: Retrieve a coupon
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/coupons/:coupon_id
      params:
      - name: coupon_id
        value: ''
        type: path
    docs: Retrieve a coupon
  - info:
      name: Create or update a coupon
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/coupons/:coupon_id
      params:
      - name: coupon_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Create or update a coupon
  - info:
      name: Delete a coupon
      type: http
    http:
      method: DELETE
      url: https://api.fastspring.com/coupons/:coupon_id
      params:
      - name: coupon_id
        value: ''
        type: path
    docs: Delete a coupon
  - info:
      name: List codes for a coupon
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/coupons/:coupon_id/codes
      params:
      - name: coupon_id
        value: ''
        type: path
    docs: List codes for a coupon
  - info:
      name: Add codes to a coupon
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/coupons/:coupon_id/codes
      params:
      - name: coupon_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Add codes to a coupon
  - info:
      name: Delete all codes for a coupon
      type: http
    http:
      method: DELETE
      url: https://api.fastspring.com/coupons/:coupon_id/codes
      params:
      - name: coupon_id
        value: ''
        type: path
    docs: Delete all codes for a coupon
- info:
    name: Orders
    type: folder
  items:
  - info:
      name: List orders
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/orders
    docs: List orders
  - info:
      name: Retrieve an order
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/orders/:order_id
      params:
      - name: order_id
        value: ''
        type: path
    docs: Retrieve an order
  - info:
      name: Update order tags and attributes
      type: http
    http:
      method: PATCH
      url: https://api.fastspring.com/orders/:order_id
      params:
      - name: order_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update order tags and attributes
- info:
    name: Products
    type: folder
  items:
  - info:
      name: List product path identifiers
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/products
    docs: List product path identifiers
  - info:
      name: Create or update products (batch up to 300)
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/products
      body:
        type: json
        data: '{}'
    docs: Create or update products (batch up to 300)
  - info:
      name: Retrieve a product
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/products/:product_path
      params:
      - name: product_path
        value: ''
        type: path
    docs: Retrieve a product
  - info:
      name: Delete a product
      type: http
    http:
      method: DELETE
      url: https://api.fastspring.com/products/:product_path
      params:
      - name: product_path
        value: ''
        type: path
    docs: Delete a product
  - info:
      name: Retrieve product prices
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/products/:product_path/prices
      params:
      - name: product_path
        value: ''
        type: path
    docs: Retrieve product prices
- info:
    name: Subscriptions
    type: folder
  items:
  - info:
      name: List subscription identifiers
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/subscriptions
    docs: List subscription identifiers
  - info:
      name: Retrieve a subscription
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/subscriptions/:subscription_id
      params:
      - name: subscription_id
        value: ''
        type: path
    docs: Retrieve a subscription
  - info:
      name: Update a subscription
      type: http
    http:
      method: PATCH
      url: https://api.fastspring.com/subscriptions/:subscription_id
      params:
      - name: subscription_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a subscription
  - info:
      name: List subscription transactions
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/subscriptions/:subscription_id/entries
      params:
      - name: subscription_id
        value: ''
        type: path
    docs: List subscription transactions
  - info:
      name: Pause a subscription
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/subscriptions/:subscription_id/pause
      params:
      - name: subscription_id
        value: ''
        type: path
    docs: Pause a subscription
  - info:
      name: Resume a paused subscription
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/subscriptions/:subscription_id/resume
      params:
      - name: subscription_id
        value: ''
        type: path
    docs: Resume a paused subscription
  - info:
      name: Cancel a subscription
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/subscriptions/:subscription_id/cancel
      params:
      - name: subscription_id
        value: ''
        type: path
    docs: Cancel a subscription
  - info:
      name: Convert trial to paid
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/subscriptions/:subscription_id/convert
      params:
      - name: subscription_id
        value: ''
        type: path
    docs: Convert trial to paid
- info:
    name: Sessions
    type: folder
  items:
  - info:
      name: Create a checkout session
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/sessions
      body:
        type: json
        data: '{}'
    docs: Create a checkout session
  - info:
      name: Retrieve a session
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/sessions/:session_id
      params:
      - name: session_id
        value: ''
        type: path
    docs: Retrieve a session
  - info:
      name: Update a session
      type: http
    http:
      method: PATCH
      url: https://api.fastspring.com/sessions/:session_id
      params:
      - name: session_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a session
  - info:
      name: Add items to a session
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/sessions/:session_id/items
      params:
      - name: session_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Add items to a session
  - info:
      name: Update a session item
      type: http
    http:
      method: PATCH
      url: https://api.fastspring.com/sessions/:session_id/items/:item_id
      params:
      - name: session_id
        value: ''
        type: path
      - name: item_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a session item
  - info:
      name: Delete a session item
      type: http
    http:
      method: DELETE
      url: https://api.fastspring.com/sessions/:session_id/items/:item_id
      params:
      - name: session_id
        value: ''
        type: path
      - name: item_id
        value: ''
        type: path
    docs: Delete a session item
  - info:
      name: Retrieve available payment methods for a session
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/sessions/:session_id/payment-methods
      params:
      - name: session_id
        value: ''
        type: path
    docs: Retrieve available payment methods for a session
- info:
    name: Invoices
    type: folder
  items:
  - info:
      name: Create a custom invoice
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/invoices
      body:
        type: json
        data: '{}'
    docs: Create a custom invoice
  - info:
      name: Retrieve an invoice
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/invoices/:invoice_id
      params:
      - name: invoice_id
        value: ''
        type: path
    docs: Retrieve an invoice
- info:
    name: Quotes
    type: folder
  items:
  - info:
      name: List quotes
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/quotes
    docs: List quotes
  - info:
      name: Create a quote
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/quotes
      body:
        type: json
        data: '{}'
    docs: Create a quote
  - info:
      name: Retrieve a quote
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/quotes/:quote_id
      params:
      - name: quote_id
        value: ''
        type: path
    docs: Retrieve a quote
  - info:
      name: Update a quote
      type: http
    http:
      method: PATCH
      url: https://api.fastspring.com/quotes/:quote_id
      params:
      - name: quote_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a quote
  - info:
      name: Cancel a quote
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/quotes/:quote_id/cancel
      params:
      - name: quote_id
        value: ''
        type: path
    docs: Cancel a quote
- info:
    name: Returns
    type: folder
  items:
  - info:
      name: Create a return / refund request
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/returns
      body:
        type: json
        data: '{}'
    docs: Create a return / refund request
  - info:
      name: Retrieve a return
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/returns/:return_id
      params:
      - name: return_id
        value: ''
        type: path
    docs: Retrieve a return
- info:
    name: Events
    type: folder
  items:
  - info:
      name: List processed / unprocessed webhook events
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/events
    docs: List processed / unprocessed webhook events
  - info:
      name: Mark an event as processed
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/events/:event_id
      params:
      - name: event_id
        value: ''
        type: path
    docs: Mark an event as processed
- info:
    name: Data
    type: folder
  items:
  - info:
      name: Generate a revenue data job
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/data/jobs/revenue-report
    docs: Generate a revenue data job
  - info:
      name: Generate a subscription data job
      type: http
    http:
      method: POST
      url: https://api.fastspring.com/data/jobs/subscription-report
    docs: Generate a subscription data job
  - info:
      name: Get data job status
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/data/jobs/:job_id
      params:
      - name: job_id
        value: ''
        type: path
    docs: Get data job status
  - info:
      name: Download a completed data job report
      type: http
    http:
      method: GET
      url: https://api.fastspring.com/data/jobs/:job_id/download
      params:
      - name: job_id
        value: ''
        type: path
    docs: Download a completed data job report
- info:
    name: Webhooks
    type: folder
  items:
  - info:
      name: Rotate a webhook's HMAC SHA-256 secret
      type: http
    http:
      method: PATCH
      url: https://api.fastspring.com/webhooks/:webhook_id/key
      params:
      - name: webhook_id
        value: ''
        type: path
    docs: Rotate a webhook's HMAC SHA-256 secret
bundled: true