Recurly OneTimeAddOns API

The OneTimeAddOns API API from Recurly — 2 operation(s) for onetimeaddons api.

Operations 3

POST /api/v1/oneTimeAddOns Create One Time Add On #
PATCH /api/v1/oneTimeAddOns/{id} Update One Time Add On #
DELETE /api/v1/oneTimeAddOns/{id} Delete One Time Add On #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-line-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-subscription-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-invoice-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-subscription-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-add-on-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-purchase-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-subscription-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-billing-attempt-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-subscription-create-request-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-subscription-line-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-subscription-offer-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-subscriber-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-transaction-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-recovery-invoice-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-dunning-campaign-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-invoice-collection-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-dunning-campaign-list-schema.json

Other Resources

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/recurly:recurly-onetimeaddons-api-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

recurly-onetimeaddons-api-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Recurly OneTimeAddOns API
  version: '1.3'
  contact: {}
  description: 'Operations tagged OneTimeAddOns API across 2 of this provider''s published API definitions: recurly-commerce-api.json, recurly-commerce-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://subs.api.recurlycommerce.com
tags:
- name: OneTimeAddOns API
paths:
  /api/v1/oneTimeAddOns:
    post:
      operationId: createOneTimeAddOn
      summary: Create One Time Add On
      description: Add an one-time add-on to an upcoming order
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddOnInputDto'
      responses:
        '200':
          description: Successfully created one-time add-on
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OneTimeAddOnDto'
      security:
      - bearer: []
      tags:
      - OneTimeAddOns API
    servers:
    - url: https://subs.api.recurlycommerce.com
  /api/v1/oneTimeAddOns/{id}:
    patch:
      operationId: updateOneTimeAddOn
      summary: Update One Time Add On
      description: Update a one-time add-on
      parameters:
      - name: id
        required: true
        in: path
        description: The id of the one-time add-on
        schema:
          example: one-time-add-on-id
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOneTimeAddOnInputDTO'
      responses:
        '200':
          description: Successfully updated one-time add-on
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OneTimeAddOnDto'
      security:
      - bearer: []
      tags:
      - OneTimeAddOns API
    delete:
      operationId: deleteOneTimeAddOn
      summary: Delete One Time Add On
      description: Delete a one-time add-on
      parameters:
      - name: id
        required: true
        in: path
        description: The id of the one-time add-on
        schema:
          example: one-time-add-on-id
          type: string
      responses:
        '200':
          description: Successfully deleted one-time add-on
      security:
      - bearer: []
      tags:
      - OneTimeAddOns API
    servers:
    - url: https://subs.api.recurlycommerce.com
components:
  schemas:
    OneTimeAddOnDto:
      type: object
      properties:
        id:
          type: string
        variantId:
          type: string
        quantity:
          type: number
        modifierType:
          type: string
          enum:
          - PERCENTAGE
          - AMOUNT
          - FIXED_AMOUNT
        discount:
          type: number
        variantPriceOverride:
          type: number
        discountedVariantPrice:
          type: number
          description: Calculated price after applying discount
      required:
      - id
      - variantId
      - quantity
    UpdateOneTimeAddOnInputDTO:
      type: object
      properties:
        variantId:
          type: string
        quantity:
          type: number
      required:
      - variantId
      - quantity
    AddOnInputDto:
      type: object
      properties:
        variantId:
          type: string
        quantity:
          type: number
        subscriptionId:
          type: string
        upcomingOrderDate:
          format: date-time
          type: string
          description: The date of upcoming order
          default: '2023-01-01T00:00:00.000Z'
        modifierType:
          type: string
          enum:
          - PERCENTAGE
          - AMOUNT
          - FIXED_AMOUNT
          description: 'Type of discount: PERCENTAGE or FIXED_AMOUNT'
        discount:
          type: number
          description: Discount amount. If modifierType is PERCENTAGE, this is a percentage (0-100). If FIXED_AMOUNT, this is the amount in currency.
        variantPriceOverride:
          type: number
          description: Override price for the variant, denominated in the subscription contract's currency. For merchants whose shop currency equals the contract currency this is the catalog price; on non-USD contracts it is NOT the Shopify catalog price. If specified, this will be used instead of modifierType and discount.
      required:
      - variantId
      - quantity
      - subscriptionId
      - upcomingOrderDate
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
x-refined-from:
- recurly-commerce-api.json
- recurly-commerce-openapi.yml
x-readme:
  explorer-enabled: false