aid: recurly
name: Recurly
description: Recurly is a subscription management and recurring billing platform (Recurly Subscriptions, Recurly
  Commerce for Shopify, Recurly Engage, Recurly RevRec and the Recurly Compass AI layer) that handles signups, plans,
  add-ons, coupons, dunning, invoicing, tax, revenue recognition and analytics for subscription businesses. The
  Recurly v3 REST API (v3.recurly.com, date-versioned through the Accept header, HTTP Basic with a site API key,
  Idempotency-Key replay protection) covers accounts, subscriptions, invoices, transactions, plans, purchases and
  external (app store) subscriptions; the legacy XML API v2, the Commerce, Recover and RevRec APIs, Recurly.js Elements,
  webhooks and a public Compass MCP server complete the surface.
type: Index
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: false
  label: Hosted service · you call their endpoint
  confidence: medium
  source:
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: unknown
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Unknown
  confidence: low
  source: []
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/recurly.png
x-docs-platform: readme
x-docs-platform-confidence: high
x-docs-platform-checked: 2026-10-04
tags:
- Billing
- Churn
- Dunning
- Invoicing
- MCP
- Payments
- Recurring Revenue
- Revenue Recognition
- Shopify
- Subscription
- Subscriptions
- Webhooks
tags_raw:
- Subscriptions
- Billing
- Payments
- Recurring Revenue
- Invoicing
- Dunning
- Revenue Recognition
url: https://raw.githubusercontent.com/api-evangelist/recurly/refs/heads/main/apis.yml
created: '2026-05-11'
modified: '2026-11-05'
specificationVersion: '0.23'
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
common:
- type: CapabilityMap
  url: capabilities/recurly-capability-edges.yml
  name: Recurly Business Capability Map
- type: Webhooks
  url: asyncapi/recurly-webhooks.yml
- type: AgenticAccess
  url: agentic-access/recurly-agentic-access.yml
- type: RateLimits
  url: rate-limits/recurly-rate-limits.yml
- type: Plans
  url: plans/recurly-plans-pricing.yml
- type: Spectral
  url: rules/recurly-rules.yml
- type: JSONLD
  url: json-ld/recurly-context.jsonld
- type: Vocabulary
  url: vocabulary/recurly-vocabulary.yml
- type: AgentSkill
  url: skills/_index.yml
- type: DataModel
  url: data-model/recurly-data-model.yml
- type: Components
  url: components/recurly-components.yml
- type: ChangeLog
  url: changelog/recurly-changelog.yml
- type: Idempotency
  url: conventions/recurly-conventions.yml
- type: Conventions
  url: conventions/recurly-conventions.yml
- type: Sandbox
  url: sandbox/recurly-sandbox.yml
- type: Compliance
  url: https://trust.recurly.com/
- type: OAuthScopes
  url: scopes/recurly-scopes.yml
- type: Deprecation
  url: https://recurly.com/developers/api/changelog.html
- type: Lifecycle
  url: lifecycle/recurly-lifecycle.yml
- type: DeclineCodes
  url: errors/recurly-decline-codes.yml
- type: ErrorCatalog
  url: errors/recurly-problem-types.yml
- type: Conformance
  url: conformance/recurly-conformance.yml
- type: LLMsTxt
  url: llms/recurly-llms.txt
- type: LLMsTxt
  url: llms/recurly-docs-llms.txt
- type: ToolCrosswalk
  url: mcp/recurly-tool-crosswalk.yml
- type: MCPServer
  url: mcp/recurly-mcp.yml
- type: WellKnown
  url: well-known/recurly-well-known.yml
- type: Hosts
  url: hosts/recurly-hosts.yml
- type: IntegrationEdges
  url: integrations/recurly-integration-edges.yml
- type: Vendors
  url: vendors/recurly-vendors.yml
- type: Packages
  url: packages/recurly-packages.yml
- type: Webhooks
  url: https://docs.recurly.com/recurly-subscriptions/docs/webhooks
- type: SDKs
  url: https://recurly.com/developers/
  note: Developer hub; client libraries for Ruby, Node.js, Python, Java, .NET, PHP and Go are linked from the API
    reference and https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
- type: Authentication
  url: authentication/recurly-authentication.yml
- type: PrivacyPolicy
  url: https://recurly.com/legal/privacy
- type: TermsOfService
  url: https://recurly.com/legal/terms
- type: TrustCenter
  url: security/recurly-trust-center.yml
- type: DomainSecurity
  url: security/recurly-domain-security.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/recurly
- type: Website
  url: https://recurly.com
- type: Documentation
  url: https://docs.recurly.com
- type: DeveloperPortal
  url: https://recurly.com/developers/
- type: APIReference
  url: https://recurly.com/developers/api/
- type: Pricing
  url: https://recurly.com/pricing/
- type: GitHubOrganization
  url: https://github.com/recurly
- type: Support
  url: https://recurly.zendesk.com
- type: StatusPage
  url: https://status.recurly.com
- type: LlmsText
  url: https://docs.recurly.com/llms.txt
- url: https://recurly.com/blog/rss.xml
  type: BlogRSS
- type: SignUp
  url: https://info.recurly.com/signup
- type: Login
  url: https://app.recurly.com/login
- type: Newsroom
  url: https://recurly.com/newsroom/
- type: Security
  url: https://recurly.com/legal/security/
- type: GettingStarted
  url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
- type: Blog
  url: https://recurly.com/blog/
- type: Sandbox
  url: https://docs.recurly.com/recurly-subscriptions/docs/sandbox-features-to-discover
- type: Integrations
  url: https://recurly.com/partners-integrations/
- type: ChangeLog
  url: https://docs.recurly.com/recurly-subscriptions/changelog
- type: Subprocessors
  url: https://recurly.com/legal/privacy/subprocessors/
apis:
- name: Recurly Compass MCP server
  description: >-
    Public, OAuth-protected Model Context Protocol server (streamable HTTP) exposing Recurly Compass Knowledge
    Agent (docs_search) and Coding Agent (api_reference_search) to Claude, Cursor and other MCP clients;
    early access, authenticated through oauth.recurly.com with the mcp:tools scope.
  humanURL: https://docs.recurly.com/recurly-subscriptions/docs/compass-public-mcp-server
  baseURL: https://mcp.recurly.com/mcp
  properties:
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/compass-public-mcp-server
  aid: recurly:recurly-compass-mcp-server
- aid: recurly:recurly-account-acquisition-info-api
  name: Recurly Account Acquisition Info API
  description: >-
    Recurly offers the ability to record marketing data on customer accounts to match this data with revenue
    and billing data events in Recurly.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Account Acquisition Info
  properties:
  - type: OpenAPI
    url: openapi/recurly-account-acquisition-info-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-account-api
  name: Recurly Account API
  description: >-
    Accounts are core to managing your customers inside of Recurly. The account object stores the entire
    Recurly history of your customer and acts as the entry point for working with a customer's billing
    information, subscription data, transactions, invoices and more.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Account
  properties:
  - type: OpenAPI
    url: openapi/recurly-account-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-account-note-api
  name: Recurly Account Note API
  description: >-
    Account notes allow your team to leave notes on an account to add context, e.g. the reason for a refund,
    customer requests, and/or complaints. These notes are internal and not exposed to your customers.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Account Note
  properties:
  - type: OpenAPI
    url: openapi/recurly-account-note-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-accounts-api
  name: Recurly Accounts API
  description: The accounts API from Recurly — 5 operation(s) for accounts.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - accounts
  properties:
  - type: OpenAPI
    url: openapi/recurly-accounts-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-add-on-api
  name: Recurly Add On API
  description: >-
    An add-on is a charge billed each billing period in addition to a subscription’s base charge. Each
    plan may have one or more add-ons associated with it.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Add-on
  properties:
  - type: OpenAPI
    url: openapi/recurly-add-on-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-adjustments-api
  name: Recurly Adjustments API
  description: The adjustments API from Recurly — 2 operation(s) for adjustments.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - adjustments
  properties:
  - type: OpenAPI
    url: openapi/recurly-adjustments-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-automated-exports-api
  name: Recurly Automated Exports API
  description: Automated exports of customer data.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Automated Exports
  properties:
  - type: OpenAPI
    url: openapi/recurly-automated-exports-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-baseorderlineitems-api-api
  name: Recurly BaseOrderLineItems API
  description: The BaseOrderLineItems API API from Recurly — 1 operation(s) for baseorderlineitems api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - BaseOrderLineItems API
  properties:
  - type: OpenAPI
    url: openapi/recurly-baseorderlineitems-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-baseorders-api-api
  name: Recurly BaseOrders API
  description: The BaseOrders API API from Recurly — 1 operation(s) for baseorders api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - BaseOrders API
  properties:
  - type: OpenAPI
    url: openapi/recurly-baseorders-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-billing-info-api
  name: Recurly Billing Info API
  description: The billing-info API from Recurly — 4 operation(s) for billing-info.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - billing-info
  properties:
  - type: OpenAPI
    url: openapi/recurly-billing-info-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-billing-infos-api
  name: Recurly Billing Infos API
  description: >-
    If the premium Wallet feature is enabled, an account can have multiple payment methods stored. Examples
    include credit cards, PayPal, or bank accounts. Primary or backup billing infos can be designated
    from these endpoints.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Billing Infos
  properties:
  - type: OpenAPI
    url: openapi/recurly-billing-infos-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-billingattempts-api-api
  name: Recurly BillingAttempts API
  description: The BillingAttempts API API from Recurly — 1 operation(s) for billingattempts api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - BillingAttempts API
  properties:
  - type: OpenAPI
    url: openapi/recurly-billingattempts-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-business-entities-api
  name: Recurly Business Entities API
  description: >-
    Describes the business address that will be used for invoices and taxes depending on settings and
    subscriber location.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Business Entities
  properties:
  - type: OpenAPI
    url: openapi/recurly-business-entities-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-cancellationquestions-api-api
  name: Recurly CancellationQuestions API
  description: >-
    The CancellationQuestions API API from Recurly — 1 operation(s) for cancellationquestions api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - CancellationQuestions API
  properties:
  - type: OpenAPI
    url: openapi/recurly-cancellationquestions-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-cancellationsurveyresults-api-api
  name: Recurly CancellationSurveyResults API
  description: >-
    The CancellationSurveyResults API API from Recurly — 1 operation(s) for cancellationsurveyresults
    api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - CancellationSurveyResults API
  properties:
  - type: OpenAPI
    url: openapi/recurly-cancellationsurveyresults-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-coupon-api
  name: Recurly Coupon API
  description: >-
    Coupons can either be single codes that easily allow mass distribution by many customers or bulk coupons
    that can generate many unique coupons that can allow for individual delivery and tracking.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Coupon
  properties:
  - type: OpenAPI
    url: openapi/recurly-coupon-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-coupon-redemption-api
  name: Recurly Coupon Redemption API
  description: >-
    Coupon redemptions are created when a coupon is applied to an account or subscription. This allows
    you to track your promotions.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Coupon Redemption
  properties:
  - type: OpenAPI
    url: openapi/recurly-coupon-redemption-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-coupon-redemptions-api
  name: Recurly Coupon Redemptions API
  description: The coupon-redemptions API from Recurly — 3 operation(s) for coupon-redemptions.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - coupon-redemptions
  properties:
  - type: OpenAPI
    url: openapi/recurly-coupon-redemptions-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-coupons-api
  name: Recurly Coupons API
  description: The coupons API from Recurly — 2 operation(s) for coupons.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - coupons
  properties:
  - type: OpenAPI
    url: openapi/recurly-coupons-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-credit-payment-api
  name: Recurly Credit Payment API
  description: The Credit Payment API from Recurly — 3 operation(s) for credit payment.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Credit Payment
  properties:
  - type: OpenAPI
    url: openapi/recurly-credit-payment-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-custom-field-definition-api
  name: Recurly Custom Field Definition API
  description: >-
    Describes the fields that can be used as custom fields on accounts, items, line-items (one time charges),
    plans, or subscriptions.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Custom Field Definition
  properties:
  - type: OpenAPI
    url: openapi/recurly-custom-field-definition-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-dunning-campaigns-api
  name: Recurly Dunning Campaigns API
  description: Settings used when attempting to dun customers whose payments are declined.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Dunning Campaigns
  properties:
  - type: OpenAPI
    url: openapi/recurly-dunning-campaigns-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-external-account-api
  name: Recurly External Account API
  description: >-
    An account from an external resource that is not managed by the Recurly platform and instead is managed
    by third-party platforms like Apple App Store and Google Play Store.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - External Account
  properties:
  - type: OpenAPI
    url: openapi/recurly-external-account-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-external-invoice-api
  name: Recurly External Invoice API
  description: >-
    An invoice from an external resource that is not managed by the Recurly platform and instead is managed
    by third-party platforms like Apple App Store and Google Play Store.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - External Invoice
  properties:
  - type: OpenAPI
    url: openapi/recurly-external-invoice-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-external-payment-phase-api
  name: Recurly External Payment Phase API
  description: >-
    Details of payments in the lifecycle of a subscription from an external resource that is not managed
    by the Recurly platform, e.g. App Store or Google Play Store.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - External Payment Phase
  properties:
  - type: OpenAPI
    url: openapi/recurly-external-payment-phase-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-external-product-api
  name: Recurly External Product API
  description: >-
    A product from an external resource that is not managed by the Recurly platform and instead is managed
    by third-party platforms like Apple App Store and Google Play Store.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - External Product
  properties:
  - type: OpenAPI
    url: openapi/recurly-external-product-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-external-product-reference-api
  name: Recurly External Product Reference API
  description: >-
    Associates an external product to a corresponding resource on an external platform like the Apple
    App Store or Google Play Store.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - External Product Reference
  properties:
  - type: OpenAPI
    url: openapi/recurly-external-product-reference-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-external-subscription-api
  name: Recurly External Subscription API
  description: >-
    A subscription from an external resource that is not managed by the Recurly platform and instead is
    managed by third-party platforms like Apple App Store and Google Play Store.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - External Subscription
  properties:
  - type: OpenAPI
    url: openapi/recurly-external-subscription-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-general-ledger-account-api
  name: Recurly General Ledger Account API
  description: >-
    A general ledger account is an account of record used to sort, store

    and summarize a company's transactions. Recurly supports the balance

    sheet (Liability) account and income (Revenue) account to be attached

    to business entities, plans, or at the item level.


    When invoices are created, system can default to the accounts based

    on the GL Accounts attached at the plan/item level. The accounts can

    be defaulted from the business entity level as well.


    These accounts will be used in the Revenue Recognition module to create

    the revenue journals that can be posted into Merchant GL system.


    Revenue and Liability accounts can defined in the system using this

    API or via the General Ledger Accounting page in the Admin UI and then

    used at the plan/item level.


    Recurly allows merchants to default the accounts at the following levels:

    - Business Entities (default)

    - Plans
        - Base Price
        - Setup Fee
        - Add-ons
    - Items

    - Charges

    - Gift Cards

    - Shipping Methods

    - Credits


    If you are interested in Recurly Revenue Recognition features, please

    contact a Recurly customer service representative.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - General Ledger Account
  properties:
  - type: OpenAPI
    url: openapi/recurly-general-ledger-account-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-gift-cards-api
  name: Recurly Gift Cards API
  description: >-
    Add gift card purchases to your checkout and allow gift card recipients to redeem the gift card for
    credit towards any of your products.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Gift Cards
  properties:
  - type: OpenAPI
    url: openapi/recurly-gift-cards-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-inbound-apis-api
  name: Recurly Inbound APIs API
  description: The Inbound APIs API from Recurly — 6 operation(s) for inbound apis.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://revrec.recurly.com
  tags:
  - Inbound APIs
  properties:
  - type: OpenAPI
    url: openapi/recurly-inbound-apis-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-invoice-api
  name: Recurly Invoice API
  description: >-
    An invoice relates charges, credits, and payments together. When a subscription is created or renewed
    or a charge is created on the account, Recurly will sum the charges, discount or tax as appropriate,
    and send the invoice out for collection.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Invoice
  properties:
  - type: OpenAPI
    url: openapi/recurly-invoice-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-invoice-templates-api
  name: Recurly Invoice Templates API
  description: The Invoice Templates API from Recurly — 2 operation(s) for invoice templates.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Invoice Templates
  properties:
  - type: OpenAPI
    url: openapi/recurly-invoice-templates-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-invoices-api
  name: Recurly Invoices API
  description: The invoices API from Recurly — 8 operation(s) for invoices.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - invoices
  properties:
  - type: OpenAPI
    url: openapi/recurly-invoices-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-item-api
  name: Recurly Item API
  description: >-
    For merchants who sell the same things to many customers, documenting those offerings in a catalog
    allows for faster charge creation, easier management of offerings, and analytics about your offerings
    across all sales channels. Because your offerings can be physical, digital, or service-oriented, Recurly
    collectively calls these offerings "Items".


    Recurly's item catalog requires the Credit Invoices feature to be enabled.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Item
  properties:
  - type: OpenAPI
    url: openapi/recurly-item-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-line-item-api
  name: Recurly Line Item API
  description: Line items are the charges and credits on your customer's invoices.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Line Item
  properties:
  - type: OpenAPI
    url: openapi/recurly-line-item-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-measured-unit-api
  name: Recurly Measured Unit API
  description: >-
    A measured unit describes a usage-based add-on's usage. If different usage-based add-ons share the
    same measured unit, you can report on customer usage for those add-ons at the aggregated measured
    unit level.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Measured Unit
  properties:
  - type: OpenAPI
    url: openapi/recurly-measured-unit-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-memberships-api-api
  name: Recurly Memberships API
  description: The Memberships API API from Recurly — 2 operation(s) for memberships api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - Memberships API
  properties:
  - type: OpenAPI
    url: openapi/recurly-memberships-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-onetimeaddons-api-api
  name: Recurly OneTimeAddOns API
  description: The OneTimeAddOns API API from Recurly — 2 operation(s) for onetimeaddons api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - OneTimeAddOns API
  properties:
  - type: OpenAPI
    url: openapi/recurly-onetimeaddons-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-orderlineitems-api-api
  name: Recurly OrderLineItems API
  description: The OrderLineItems API API from Recurly — 1 operation(s) for orderlineitems api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - OrderLineItems API
  properties:
  - type: OpenAPI
    url: openapi/recurly-orderlineitems-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-orders-api-api
  name: Recurly Orders API
  description: The Orders API API from Recurly — 2 operation(s) for orders api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - Orders API
  properties:
  - type: OpenAPI
    url: openapi/recurly-orders-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-outbound-report-apis-api
  name: Recurly Outbound Report APIs API
  description: The Outbound Report APIs API from Recurly — 6 operation(s) for outbound report apis.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://revrec.recurly.com
  tags:
  - Outbound Report APIs
  properties:
  - type: OpenAPI
    url: openapi/recurly-outbound-report-apis-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-paths-api
  name: Recurly Paths API
  description: The Paths API from Recurly — 5 operation(s) for paths.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://conduit.redfast.com
  tags:
  - Paths
  properties:
  - type: OpenAPI
    url: openapi/recurly-paths-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-performance-obligations-api
  name: Recurly Performance Obligations API
  description: >-
    A performance obligation is a promise to provide a distinct good or

    service or a series of distinct goods or services as defined by the revenue standard.

    Performance obligations are completed and revenue is recognized either at a point in

    time or over a period of time, depending on the type of obligation.

    - Point in time  a company has to go through the criteria and determine if a performance

    obligation is satisfied over time. If it does not meet those criteria, then the performance

    obligation is satisfied and revenue recognized at the point in time when control of the good

    or service is transferred to the customer.

    - Over a period of time  a performance obligation is satisfied and revenue is recognized over

    time if at least one of the following are met:
      - The customer receives and consumes the benefits of the goods or services as they are provided
      by the entity (routine, recurring services like a cleaning service are an example of a series of
      services that are substantially the same and have the same pattern of transfer)
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Performance Obligations
  properties:
  - type: OpenAPI
    url: openapi/recurly-performance-obligations-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-ping-api
  name: Recurly Ping API
  description: The Ping API from Recurly — 2 operation(s) for ping.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://conduit.redfast.com
  tags:
  - Ping
  properties:
  - type: OpenAPI
    url: openapi/recurly-ping-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-plan-add-ons-api
  name: Recurly Plan Add Ons API
  description: The plan-add-ons API from Recurly — 3 operation(s) for plan-add-ons.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - plan-add-ons
  properties:
  - type: OpenAPI
    url: openapi/recurly-plan-add-ons-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-plan-api
  name: Recurly Plan API
  description: >-
    A plan tells Recurly how often and how much to charge your customers. Plans can be created with free
    trials, optional products (called add-ons), setup fees, and more.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Plan
  properties:
  - type: OpenAPI
    url: openapi/recurly-plan-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-plans-api
  name: Recurly Plans API
  description: The plans API from Recurly — 2 operation(s) for plans.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - plans
  properties:
  - type: OpenAPI
    url: openapi/recurly-plans-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-price-segment-api
  name: Recurly Price Segment API
  description: The Price Segment API from Recurly — 2 operation(s) for price segment.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Price Segment
  properties:
  - type: OpenAPI
    url: openapi/recurly-price-segment-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-products-api-api
  name: Recurly Products API
  description: The Products API API from Recurly — 1 operation(s) for products api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - Products API
  properties:
  - type: OpenAPI
    url: openapi/recurly-products-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-purchase-api
  name: Recurly Purchase API
  description: >-
    A purchase is a checkout containing at least one or more subscriptions or one-time charges (line items)
    and supports both coupon and gift card redemptions. All items purchased will be on one invoice and
    paid for with one transaction. The purchases endpoint can also be used to immediately create a credit
    invoice on an account, when Credit Invoices is enabled on your site.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Purchase
  properties:
  - type: OpenAPI
    url: openapi/recurly-purchase-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-revenue-recovery-api
  name: Recurly Revenue Recovery API
  description: Revenue recovery
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Revenue Recovery
  properties:
  - type: OpenAPI
    url: openapi/recurly-revenue-recovery-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-shipping-address-api
  name: Recurly Shipping Address API
  description: >-
    Shipping addresses are tied to a customer's account. Each account can have up to 20 different shipping
    addresses, and if you have enabled multiple subscriptions per account, you can associate different
    shipping addresses to each subscription.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Shipping Address
  properties:
  - type: OpenAPI
    url: openapi/recurly-shipping-address-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-shipping-method-api
  name: Recurly Shipping Method API
  description: Shipping methods offered to send products to customers.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Shipping Method
  properties:
  - type: OpenAPI
    url: openapi/recurly-shipping-method-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-site-api
  name: Recurly Site API
  description: The Site API from Recurly — 2 operation(s) for site.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Site
  properties:
  - type: OpenAPI
    url: openapi/recurly-site-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-subscribers-api-api
  name: Recurly Subscribers API
  description: The Subscribers API API from Recurly — 5 operation(s) for subscribers api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - Subscribers API
  properties:
  - type: OpenAPI
    url: openapi/recurly-subscribers-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-subscription-api
  name: Recurly Subscription API
  description: >-
    Subscriptions are created when your customers subscribe to one of your plans. The customer's subscription
    tells Recurly when and how much to bill the customer.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Subscription
  properties:
  - type: OpenAPI
    url: openapi/recurly-subscription-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-subscription-change-api
  name: Recurly Subscription Change API
  description: >-
    Subscription changes alter subscription in a way that might affect the invoiced amount, such as changing
    the plan, add-ons, quantities, or shipping address. Changes can be made immediately in the current
    billing cycle or scheduled to take place at the next renewal.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Subscription Change
  properties:
  - type: OpenAPI
    url: openapi/recurly-subscription-change-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-subscription-offers-api-api
  name: Recurly Subscription Offers API
  description: >-
    The Subscription Offers API API from Recurly — 2 operation(s) for subscription offers api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - Subscription Offers API
  properties:
  - type: OpenAPI
    url: openapi/recurly-subscription-offers-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-subscriptionactivities-api-api
  name: Recurly SubscriptionActivities API
  description: >-
    The SubscriptionActivities API API from Recurly — 1 operation(s) for subscriptionactivities api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - SubscriptionActivities API
  properties:
  - type: OpenAPI
    url: openapi/recurly-subscriptionactivities-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-subscriptiondiscountcodes-api-api
  name: Recurly SubscriptionDiscountCodes API
  description: >-
    The SubscriptionDiscountCodes API API from Recurly — 1 operation(s) for subscriptiondiscountcodes
    api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - SubscriptionDiscountCodes API
  properties:
  - type: OpenAPI
    url: openapi/recurly-subscriptiondiscountcodes-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-subscriptionlines-api-api
  name: Recurly SubscriptionLines API
  description: The SubscriptionLines API API from Recurly — 7 operation(s) for subscriptionlines api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - SubscriptionLines API
  properties:
  - type: OpenAPI
    url: openapi/recurly-subscriptionlines-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-subscriptions-api-api
  name: Recurly Subscriptions API
  description: The Subscriptions API API from Recurly — 17 operation(s) for subscriptions api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - Subscriptions API
  properties:
  - type: OpenAPI
    url: openapi/recurly-subscriptions-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-subscriptions-api
  name: Recurly Subscriptions API
  description: The subscriptions API from Recurly — 10 operation(s) for subscriptions.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - subscriptions
  properties:
  - type: OpenAPI
    url: openapi/recurly-subscriptions-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-swapandaddonoptions-api-api
  name: Recurly SwapAndAddOnOptions API
  description: >-
    The SwapAndAddOnOptions API API from Recurly — 1 operation(s) for swapandaddonoptions api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - SwapAndAddOnOptions API
  properties:
  - type: OpenAPI
    url: openapi/recurly-swapandaddonoptions-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-transaction-api
  name: Recurly Transaction API
  description: >-
    Purchasing information is sent to your payment gateway in an action called a transaction. This includes
    the customer's billing information and the amount of money to be charged, voided, or refunded.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Transaction
  properties:
  - type: OpenAPI
    url: openapi/recurly-transaction-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-transactions-api
  name: Recurly Transactions API
  description: The transactions API from Recurly — 3 operation(s) for transactions.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - transactions
  properties:
  - type: OpenAPI
    url: openapi/recurly-transactions-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-unique-coupon-code-api
  name: Recurly Unique Coupon Code API
  description: Unique coupon codes are generated from bulk coupons.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Unique Coupon Code
  properties:
  - type: OpenAPI
    url: openapi/recurly-unique-coupon-code-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-usage-api
  name: Recurly Usage API
  description: >-
    Send Recurly your customer usage and we will automatically bill them in arrears at the end of the
    billing cycle. For more info on usage-based billing, [click here](https://docs.recurly.com/docs/usage-based-billing).
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://v3.recurly.com
  tags:
  - Usage
  properties:
  - type: OpenAPI
    url: openapi/recurly-usage-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
- aid: recurly:recurly-webhooks-api-api
  name: Recurly Webhooks API
  description: The Webhooks API API from Recurly — 3 operation(s) for webhooks api.
  humanURL: https://recurly.com/developers/api/v2021-02-25/index.html
  baseURL: https://subs.api.recurlycommerce.com
  tags:
  - Webhooks API
  properties:
  - type: OpenAPI
    url: openapi/recurly-webhooks-api-api-openapi.yml
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
  - type: APIReference
    url: https://recurly.com/developers/api/v2021-02-25/index.html
  - type: Authentication
    url: https://docs.recurly.com/recurly-subscriptions/docs/api-keys
  - type: GettingStarted
    url: https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
  - type: Webhooks
    url: https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
  - type: ChangeLog
    url: https://recurly.com/developers/api/changelog.html
  - type: SourceCode
    url: https://github.com/recurly/recurly-client-spec
  - type: AsyncAPI
    url: asyncapi.yml
  - type: JSONSchema
    url: json-schema/recurly-line-item-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-schema.json
  - type: JSONSchema
    url: json-schema/recurly-add-on-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-purchase-create-schema.json
  - type: APIReference
    url: https://recurly.com/developers/api-v2/v2.29/index.html
  - type: Documentation
    url: https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
  - type: Documentation
    url: https://docs.recurly.com/recurly-commerce/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-subscription-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-billing-attempt-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-create-request-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-line-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscription-offer-dto-schema.json
  - type: JSONSchema
    url: json-schema/recurly-subscriber-dto-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-recover/docs/getting-started
  - type: JSONSchema
    url: json-schema/recurly-transaction-schema.json
  - type: JSONSchema
    url: json-schema/recurly-recovery-invoice-create-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-schema.json
  - type: JSONSchema
    url: json-schema/recurly-invoice-collection-schema.json
  - type: JSONSchema
    url: json-schema/recurly-dunning-campaign-list-schema.json
  - type: Documentation
    url: https://docs.recurly.com/recurly-revrec/docs/getting-started
  - type: Documentation
    url: https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk
x-enrichment:
  date: '2026-11-05'
  status: enriched
  artifacts_added: 72
  pass: local-v6
