Maxio Referral Codes API

openapi: 3.2.0
info:
  title: Maxio Referral Codes API
  version: '1.0'
  contact:
    email: support@maxio.com
  description: 'Operations tagged Referral Codes across 2 of this provider''s published API definitions: maxio-advanced-billing-openapi31json.json, maxio-advanced-billing-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{site}.chargify.com
  description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
  variables:
    site:
      default: subdomain
      description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
  description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
  variables:
    site:
      default: subdomain
      description: The subdomain for your Advanced Billing site.
- url: https://{site}.ebilling.maxio.com
  description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
  variables:
    site:
      default: subdomain
      description: The subdomain for your Advanced Billing site.
security:
- BasicAuth: []
tags:
- name: Referral Codes
  description: The Referral Code object represents a code attached to a subscription, used to track and validate referrals as part of a referral program. For more information, see Understand Referrals.
paths:
  /referral_codes/validate.json:
    parameters: []
    get:
      tags:
      - Referral Codes
      summary: validateReferralCode
      description: 'Validates whether a referral code is valid and applicable within your site. This method is useful for validating referral codes that are entered by a customer.


        For more information, see Understanding Referrals in the product documentation.'
      operationId: validateReferralCode
      parameters:
      - name: code
        in: query
        description: The referral code you are trying to validate
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ReferralValidationResponse'
                - examples:
                  - referral_code:
                      id: 1032514
                      site_id: 31615
                      subscription_id: 16254270
                      code: 9b6cdw
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    referral_code:
                      id: 1032514
                      site_id: 31615
                      subscription_id: 16254270
                      code: 9b6cdw
        '404':
          description: Not Found
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SingleStringErrorResponse1'
                - examples:
                  - errors: Referral code is invalid.
                contentMediaType: application/json
              examples:
                Example:
                  value:
                    errors: Referral code is invalid.
      deprecated: false
    servers:
    - url: https://{site}.chargify.com
      description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
      variables:
        site:
          default: subdomain
          description: The subdomain for your Advanced Billing site.
    - url: https://events.chargify.com/{site}
      description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
      variables:
        site:
          default: subdomain
          description: The subdomain for your Advanced Billing site.
    - url: https://{site}.ebilling.maxio.com
      description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
      variables:
        site:
          default: subdomain
          description: The subdomain for your Advanced Billing site.
    - url: https://events.chargify.com/{site}
      description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
      variables:
        site:
          default: subdomain
          description: The subdomain for your Advanced Billing site.
components:
  schemas:
    ReferralCode:
      title: ReferralCode
      type: object
      properties:
        id:
          type: integer
          contentEncoding: int32
        site_id:
          type: integer
          contentEncoding: int32
        subscription_id:
          type: integer
          contentEncoding: int32
        code:
          type: string
    ReferralValidationResponse:
      title: ReferralValidationResponse
      type: object
      properties:
        referral_code:
          $ref: '#/components/schemas/ReferralCode'
    SingleStringErrorResponse1:
      title: SingleStringErrorResponse1
      type: object
      properties:
        errors:
          type: string
  securitySchemes:
    BasicAuth:
      type: http
      description: The `username` is a Maxio Chargify API key. The `password` is `x`.
      scheme: basic
x-refined-from:
- maxio-advanced-billing-openapi31json.json
- maxio-advanced-billing-openapi.yml
x-provenance:
  method: harvested
  publisher: Maxio
  source: https://developers.maxio.com/static/exports/maxio-advanced-billing-openapi31json.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)