Recurly External Invoice API

openapi: 3.2.0
info:
  title: Recurly External Invoice API
  version: v2021-02-25
  description: 'Operations tagged External Invoice across 2 of this provider''s published API definitions: recurly-v3-v2021-02-25-api.yaml, recurly-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://v3.recurly.com
- url: https://v3.eu.recurly.com
security:
- api_key: []
tags:
- name: External Invoice
  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.
paths:
  /external_subscriptions/{external_subscription_id}/external_invoices:
    parameters:
    - $ref: '#/components/parameters/external_subscription_id'
    post:
      tags:
      - External Invoice
      operationId: create_external_invoice
      summary: Create an external invoice
      parameters:
      - $ref: '#/components/parameters/accept_header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalInvoiceCreate'
        required: true
      responses:
        '201':
          description: Returns the external invoice
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalInvoice'
        '400':
          description: Bad request; perhaps missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: External subscription cannot be completed for the specified reason.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    servers:
    - url: https://v3.recurly.com
    - url: https://v3.eu.recurly.com
  /external_invoices:
    get:
      tags:
      - External Invoice
      operationId: list_external_invoices
      summary: List the external invoices on a site
      description: See the Pagination Guide to learn how to use pagination in the API and Client Libraries.
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/sort_dates'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/order'
      responses:
        '200':
          description: A list of the the external_invoices on a site.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalInvoiceList'
        '404':
          description: Incorrect site.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    servers:
    - url: https://v3.recurly.com
    - url: https://v3.eu.recurly.com
  /external_invoices/{external_invoice_id}:
    parameters:
    - $ref: '#/components/parameters/external_invoice_id'
    get:
      tags:
      - External Invoice
      operationId: show_external_invoice
      summary: Fetch an external invoice
      parameters:
      - $ref: '#/components/parameters/accept_header'
      responses:
        '201':
          description: Returns the external invoice
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalInvoice'
        '400':
          description: Bad request; perhaps missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: External invoice cannot be found for the specified reason.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    servers:
    - url: https://v3.recurly.com
    - url: https://v3.eu.recurly.com
components:
  schemas:
    ExternalCharge:
      type: object
      description: Charge from an external resource such as Apple App Store or Google Play Store.
      properties:
        id:
          type: string
          title: External invoice ID
          description: System-generated unique identifier for an external charge ID, e.g. `e28zov4fw0v2`.
        object:
          type: string
          title: Object type
        account:
          $ref: '#/components/schemas/AccountMini'
        currency:
          type: string
          title: Currency
          description: 3-letter ISO 4217 currency code.
        unit_amount:
          type: string
          format: decimal
          title: Unit Amount
        quantity:
          type: integer
        description:
          type: string
        external_product_reference:
          $ref: '#/components/schemas/ExternalProductReferenceMini'
        created_at:
          type: string
          format: date-time
          title: Created at
          description: When the external charge was created in Recurly.
        updated_at:
          type: string
          format: date-time
          title: Updated at
          description: When the external charge was updated in Recurly.
    PlanCode:
      type: string
      title: Plan code
      description: Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.
      pattern: /^[a-z0-9_+-]+$/
      maxLength: 50
    ExternalSubscription:
      type: object
      description: Subscription from an external resource such as Apple App Store or Google Play Store.
      properties:
        id:
          type: string
          title: External subscription ID
          description: System-generated unique identifier for an external subscription ID, e.g. `e28zov4fw0v2`.
        object:
          type: string
          title: Object type
        account:
          $ref: '#/components/schemas/AccountMini'
        external_product_reference:
          $ref: '#/components/schemas/ExternalProductReferenceMini'
        external_product:
          $ref: '#/components/schemas/ExternalProductMini'
        plan:
          $ref: '#/components/schemas/PlanMini'
        external_payment_phases:
          type: array
          title: External payment phases
          description: The phases of the external subscription payment lifecycle.
          items:
            $ref: '#/components/schemas/ExternalPaymentPhase'
        external_id:
          type: string
          title: External Id
          description: The id of the subscription in the external systems., I.e. Apple App Store or Google Play Store.
        uuid:
          type: string
          title: Uuid
          description: Universally Unique Identifier created automatically.
        last_purchased:
          type: string
          format: date-time
          title: Last purchased
          description: When a new billing event occurred on the external subscription in conjunction with a recent billing period, reactivation or upgrade/downgrade.
        auto_renew:
          type: boolean
          title: Auto-renew
          description: An indication of whether or not the external subscription will auto-renew at the expiration date.
          default: false
        in_grace_period:
          type: boolean
          title: In grace period
          description: An indication of whether or not the external subscription is in a grace period.
          default: false
        app_identifier:
          type: string
          title: App identifier
          description: Identifier of the app that generated the external subscription.
        quantity:
          type: integer
          title: Quantity
          description: An indication of the quantity of a subscribed item's quantity.
          default: 1
          minimum: 0
        state:
          type: string
          description: External subscriptions can be active, canceled, expired, past_due, voided, revoked, or paused.
          default: active
        activated_at:
          type: string
          format: date-time
          title: Activated at
          description: When the external subscription was activated in the external platform.
        canceled_at:
          type: string
          format: date-time
          title: Canceled at
          description: When the external subscription was canceled in the external platform.
        expires_at:
          type: string
          format: date-time
          title: Expires at
          description: When the external subscription expires in the external platform.
        trial_started_at:
          type: string
          format: date-time
          title: Trial started at
          description: When the external subscription trial period started in the external platform.
        trial_ends_at:
          type: string
          format: date-time
          title: Trial ends at
          description: When the external subscription trial period ends in the external platform.
        test:
          type: boolean
          title: Test
          description: An indication of whether or not the external subscription was purchased in a sandbox environment.
          default: false
        imported:
          type: boolean
          title: Imported
          description: An indication of whether or not the external subscription was created by a historical data import.
          default: false
        created_at:
          type: string
          format: date-time
          title: Created at
          description: When the external subscription was created in Recurly.
        updated_at:
          type: string
          format: date-time
          title: Updated at
          description: When the external subscription was updated in Recurly.
    AlphanumericSortEnum:
      type: string
      enum:
      - asc
      - desc
    AccountMini:
      type: object
      title: Account mini details
      properties:
        id:
          type: string
          maxLength: 13
          readOnly: true
        object:
          type: string
          title: Object type
          readOnly: true
        code:
          type: string
          description: The unique identifier of the account.
          maxLength: 50
        email:
          type: string
          format: email
          description: The email address used for communicating with this customer.
          maxLength: 255
        first_name:
          type: string
          maxLength: 255
        last_name:
          type: string
          maxLength: 255
        company:
          type: string
          maxLength: 255
        parent_account_id:
          type: string
          maxLength: 13
        bill_to:
          type: string
          maxLength: 6
        dunning_campaign_id:
          type: string
          title: Dunning Campaign ID
          description: Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
    ExternalProductReferenceBase:
      type: object
      properties:
        reference_code:
          type: string
          description: A code which associates the external product to a corresponding object or resource in an external platform like the Apple App Store or Google Play Store.
          maxLength: 255
        external_connection_type:
          $ref: '#/components/schemas/ExternalProductReferenceConnectionType'
    ErrorTypeEnum:
      type: string
      enum:
      - bad_request
      - immutable_subscription
      - internal_server_error
      - invalid_api_key
      - invalid_api_version
      - invalid_content_type
      - invalid_permissions
      - invalid_token
      - missing_feature
      - not_found
      - rate_limited
      - service_not_available
      - simultaneous_request
      - tax_service_error
      - transaction
      - unauthorized
      - unavailable_in_api_version
      - unknown_api_version
      - validation
    ExternalProductReferenceCreate:
      allOf:
      - $ref: '#/components/schemas/ExternalProductReferenceBase'
      required:
      - reference_code
      - external_connection_type
    ExternalInvoice:
      type: object
      description: Invoice from an external resource such as Apple App Store or Google Play Store.
      properties:
        id:
          type: string
          title: External invoice ID
          description: System-generated unique identifier for an external invoice ID, e.g. `e28zov4fw0v2`.
        object:
          type: string
          title: Object type
        account:
          $ref: '#/components/schemas/AccountMini'
        external_subscription:
          $ref: '#/components/schemas/ExternalSubscription'
        external_id:
          type: string
          description: An identifier which associates the external invoice to a corresponding object in an external platform.
        state:
          $ref: '#/components/schemas/ExternalInvoiceStateEnum'
        total:
          type: string
          format: decimal
          title: Total
        currency:
          type: string
          title: Currency
          description: 3-letter ISO 4217 currency code.
        line_items:
          type: array
          items:
            $ref: '#/components/schemas/ExternalCharge'
        purchased_at:
          type: string
          format: date-time
          description: When the invoice was created in the external platform.
        created_at:
          type: string
          format: date-time
          description: When the external invoice was created in Recurly.
        updated_at:
          type: string
          format: date-time
          title: Updated at
          description: When the external invoice was updated in Recurly.
    AcceptHeaderEnum:
      type: string
      enum:
      - application/vnd.recurly.v2021-02-25
      - application/vnd.recurly.v2021-02-25+json
    TimestampSortEnum:
      type: string
      enum:
      - created_at
      - updated_at
    ExternalProductMini:
      type: object
      title: External product mini details
      description: Just the important parts.
      properties:
        id:
          type: string
          title: External product ID
          readOnly: true
        object:
          type: string
          title: Object type
          readOnly: true
        name:
          type: string
          title: Name
          description: The merchant-facing name of the external product.
    PlanMini:
      type: object
      title: Plan mini details
      description: Just the important parts.
      properties:
        id:
          type: string
          title: Plan ID
          maxLength: 13
          readOnly: true
        object:
          type: string
          title: Object type
          readOnly: true
        code:
          $ref: '#/components/schemas/PlanCode'
        name:
          $ref: '#/components/schemas/PlanName'
    ExternalInvoiceCreate:
      type: object
      properties:
        external_id:
          type: string
          description: An identifier which associates the external invoice to a corresponding object in an external platform.
        state:
          $ref: '#/components/schemas/ExternalInvoiceStateEnum'
        total:
          type: string
          format: decimal
        currency:
          type: string
          title: Currency
          description: 3-letter ISO 4217 currency code.
          maxLength: 3
        purchased_at:
          type: string
          format: date-time
          description: When the invoice was created in the external platform.
        line_items:
          type: array
          items:
            $ref: '#/components/schemas/ExternalChargeCreate'
        external_payment_phase:
          $ref: '#/components/schemas/ExternalPaymentPhaseBase'
        external_payment_phase_id:
          type: string
          description: External payment phase ID, e.g. `a34ypb2ef9w1`.
      required:
      - external_id
      - state
      - total
      - currency
      - purchased_at
    ExternalChargeCreate:
      type: object
      properties:
        currency:
          type: string
          title: Currency
          description: 3-letter ISO 4217 currency code.
          maxLength: 3
        unit_amount:
          type: string
          format: decimal
        quantity:
          type: integer
        description:
          type: string
        external_product_reference:
          $ref: '#/components/schemas/ExternalProductReferenceCreate'
      required:
      - quantity
      - currency
      - unit_amount
    Error:
      type: object
      properties:
        type:
          title: Type
          $ref: '#/components/schemas/ErrorTypeEnum'
        message:
          type: string
          title: Message
        params:
          type: array
          title: Parameter specific errors
          items:
            type: object
            properties:
              param:
                type: string
    ExternalProductReferenceMini:
      type: object
      title: External Product Reference details
      description: External Product Reference details
      properties:
        id:
          type: string
          title: External Product ID
          description: System-generated unique identifier for an external product ID, e.g. `e28zov4fw0v2`.
        object:
          type: string
          title: object
        reference_code:
          type: string
          title: reference_code
          description: A code which associates the external product to a corresponding object or resource in an external platform like the Apple App Store or Google Play Store.
        external_connection_type:
          type: string
          title: external_connection_type
          description: Source connection platform.
        created_at:
          type: string
          format: date-time
          description: When the external product was created in Recurly.
        updated_at:
          type: string
          format: date-time
          description: When the external product was updated in Recurly.
    PlanName:
      type: string
      title: Name
      description: This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
      maxLength: 255
    ExternalInvoiceStateEnum:
      type: string
      enum:
      - paid
    ExternalProductReferenceConnectionType:
      type: string
      description: Represents the connection type. One of the connection types of your enabled App Connectors
    ExternalInvoiceList:
      type: object
      properties:
        object:
          type: string
          title: Object type
          description: Will always be List.
        has_more:
          type: boolean
          description: Indicates there are more results on subsequent pages.
        next:
          type: string
          description: Path to subsequent page of results.
        data:
          type: array
          items:
            $ref: '#/components/schemas/ExternalInvoice'
    ExternalPaymentPhaseBase:
      type: object
      properties:
        started_at:
          type: string
          format: date-time
          title: Started At
        ends_at:
          type: string
          format: date-time
          title: Ends At
        starting_billing_period_index:
          type: integer
          title: Starting Billing Period Index
        ending_billing_period_index:
          type: integer
          title: Ending Billing Period Index
        offer_type:
          type: string
          title: Offer Type
          description: Type of discount offer given, e.g. "FREE_TRIAL"
        offer_name:
          type: string
          title: Offer Name
          description: Name of the discount offer given, e.g. "introductory"
        period_count:
          type: integer
          title: Period Count
          description: Number of billing periods
        period_length:
          type: string
          title: Period Length
          description: Billing cycle length
        amount:
          type: string
          format: decimal
          title: Amount
          minimum: 0
          description: Allows up to 9 decimal places
        currency:
          type: string
          title: Currency
          description: 3-letter ISO 4217 currency code.
          maxLength: 3
    ExternalPaymentPhase:
      type: object
      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.
      properties:
        id:
          type: string
          title: External payment phase ID
          description: System-generated unique identifier for an external payment phase ID, e.g. `e28zov4fw0v2`.
        object:
          type: string
          title: Object type
        started_at:
          type: string
          format: date-time
          title: Started At
        ends_at:
          type: string
          format: date-time
          title: Ends At
        starting_billing_period_index:
          type: integer
          title: Starting Billing Period Index
        ending_billing_period_index:
          type: integer
          title: Ending Billing Period Index
        offer_type:
          type: string
          title: Offer Type
          description: Type of discount offer given, e.g. "FREE_TRIAL"
        offer_name:
          type: string
          title: Offer Name
          description: Name of the discount offer given, e.g. "introductory"
        period_count:
          type: integer
          title: Period Count
          description: Number of billing periods
        period_length:
          type: string
          title: Period Length
          description: Billing cycle length
        amount:
          type: string
          format: decimal
          title: Amount
          minimum: 0
          description: Allows up to 9 decimal places
        currency:
          type: string
          title: Currency
          description: 3-letter ISO 4217 currency code.
          maxLength: 3
        created_at:
          type: string
          format: date-time
          title: Created at
          description: When the external subscription was created in Recurly.
        updated_at:
          type: string
          format: date-time
          title: Updated at
          description: When the external subscription was updated in Recurly.
  parameters:
    external_invoice_id:
      name: external_invoice_id
      in: path
      description: External invoice ID, e.g. `e28zov4fw0v2`.
      required: true
      schema:
        type: string
    order:
      name: order
      in: query
      description: Sort order.
      schema:
        default: desc
        $ref: '#/components/schemas/AlphanumericSortEnum'
    limit:
      name: limit
      in: query
      description: Limit number of records 1-200.
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 20
    accept_header:
      name: Accept
      in: header
      description: The API version to use for this request, e.g. `application/vnd.recurly.v2021-02-25`. Requests without a versioned `Accept` header return a 406 response.
      required: true
      schema:
        default: application/vnd.recurly.v2021-02-25
        $ref: '#/components/schemas/AcceptHeaderEnum'
    sort_dates:
      name: sort
      in: query
      description: 'Sort field. You *really* only want to sort by `updated_at` in ascending

        order. In descending order updated records will move behind the cursor and could

        prevent some records from being returned.

        '
      schema:
        default: created_at
        $ref: '#/components/schemas/TimestampSortEnum'
    external_subscription_id:
      name: external_subscription_id
      in: path
      description: External subscription id
      required: true
      schema:
        type: string
  securitySchemes:
    api_key:
      type: http
      description: Enter the API key as the username and set the password to an empty string. You can locate and manage your API keys from the [API Credentials](https://app.recurly.com/go/developer/api_keys) page.
      scheme: basic
x-refined-from:
- recurly-v3-v2021-02-25-api.yaml
- recurly-openapi.yml
x-readme:
  explorer-enabled: false