Recurly Business Entities API

openapi: 3.2.0
info:
  title: Recurly Business Entities API
  version: v2021-02-25
  description: 'Operations tagged Business Entities 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: Business Entities
  description: Describes the business address that will be used for invoices and taxes depending on settings and subscriber location.
paths:
  /business_entities/{business_entity_id}:
    parameters:
    - $ref: '#/components/parameters/business_entity_id'
    get:
      tags:
      - Business Entities
      operationId: get_business_entity
      summary: Fetch a business entity
      parameters:
      - $ref: '#/components/parameters/accept_header'
      responses:
        '200':
          description: Business entity details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessEntity'
        '404':
          description: Incorrect site or business entity ID.
          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
  /business_entities:
    get:
      tags:
      - Business Entities
      operationId: list_business_entities
      summary: List business entities
      parameters:
      - $ref: '#/components/parameters/accept_header'
      responses:
        '200':
          description: List of all business entities on your site.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessEntityList'
        '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
components:
  schemas:
    OriginTaxAddressSourceEnum:
      type: string
      title: Origin tax address source
      description: The source of the address that will be used as the origin in determining taxes. Available only when the site is on an Elite plan. A value of "origin" refers to the "Business entity tax address". A value of "destination" refers to the "Customer tax address".
      default: origin
      enum:
      - origin
      - destination
    AcceptHeaderEnum:
      type: string
      enum:
      - application/vnd.recurly.v2021-02-25
      - application/vnd.recurly.v2021-02-25+json
    BusinessEntity:
      type: object
      description: Business entity details
      properties:
        id:
          title: Business entity ID
          type: string
          maxLength: 13
          readOnly: true
        object:
          title: Object type
          type: string
          readOnly: true
        code:
          title: Business entity code
          type: string
          maxLength: 50
          description: The entity code of the business entity.
        name:
          type: string
          title: Name
          description: This name describes your business entity and will appear on the invoice.
          maxLength: 255
        invoice_display_address:
          title: Invoice display address
          description: Address information for the business entity that will appear on the invoice.
          $ref: '#/components/schemas/Address'
        tax_address:
          title: Tax address
          description: Address information for the business entity that will be used for calculating taxes.
          $ref: '#/components/schemas/Address'
        origin_tax_address_source:
          $ref: '#/components/schemas/OriginTaxAddressSourceEnum'
        destination_tax_address_source:
          $ref: '#/components/schemas/DestinationTaxAddressSourceEnum'
        default_vat_number:
          type: string
          title: Default VAT number
          description: VAT number for the customer used on the invoice.
          maxLength: 20
        default_registration_number:
          type: string
          title: Default registration number
          description: Registration number for the customer used on the invoice.
          maxLength: 30
        subscriber_location_countries:
          type: array
          title: Subscriber location countries
          description: List of countries for which the business entity will be used.
          items:
            type: string
            title: Country code
        default_liability_gl_account_id:
          type: string
          title: General Ledger Account ID
          description: 'The ID of a general ledger account. General ledger accounts are

            only accessible as a part of the Recurly RevRec Standard and

            Recurly RevRec Advanced features.

            '
          maxLength: 13
        default_revenue_gl_account_id:
          type: string
          title: General Ledger Account ID
          description: 'The ID of a general ledger account. General ledger accounts are

            only accessible as a part of the Recurly RevRec Standard and

            Recurly RevRec Advanced features.

            '
          maxLength: 13
        created_at:
          type: string
          format: date-time
          title: Created at
          readOnly: true
        updated_at:
          type: string
          format: date-time
          title: Last updated at
          readOnly: true
    BusinessEntityList:
      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/BusinessEntity'
    DestinationTaxAddressSourceEnum:
      type: string
      title: Destination tax address source
      description: The source of the address that will be used as the destinaion in determining taxes. Available only when the site is on an Elite plan. A value of "destination" refers to the "Customer tax address". A value of "origin" refers to the "Business entity tax address".
      default: destination
      enum:
      - destination
      - origin
    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
    Address:
      type: object
      properties:
        phone:
          type: string
          title: Phone number
        street1:
          type: string
          title: Street 1
          maxLength: 50
        street2:
          type: string
          title: Street 2
          maxLength: 50
        city:
          type: string
          title: City
        region:
          type: string
          title: State/Province
          description: State or province.
        postal_code:
          type: string
          title: Zip/Postal code
          description: Zip or postal code.
        country:
          type: string
          title: Country
          description: Country, 2-letter ISO 3166-1 alpha-2 code.
        geo_code:
          type: string
          maxLength: 20
          description: Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
    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
  parameters:
    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'
    business_entity_id:
      name: business_entity_id
      in: path
      description: Business Entity ID. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-entity1`.
      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