Recurly Account Note API

openapi: 3.2.0
info:
  title: Recurly Account Note API
  version: v2021-02-25
  description: 'Operations tagged Account Note 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: Account Note
  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.
paths:
  /accounts/{account_id}/notes:
    get:
      tags:
      - Account Note
      operationId: list_account_notes
      summary: List an account's notes
      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/account_id'
      - $ref: '#/components/parameters/ids'
      responses:
        '200':
          description: A list of an account's notes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountNoteList'
        '404':
          description: Incorrect site or account ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples:
      - lang: Node.js
        source: "const notes = client.listAccountNotes(accountId, { params: { limit: 200 } })\n\nfor await (const note of notes.each()) {\n  console.log(note.message)\n}\n"
      - lang: Python
        source: "params = {\"limit\": 200}\nline_items = client.list_account_line_items(account_id, params=params).items()\nfor line_item in line_items:\n    print(line_item.id)\n"
      - lang: .NET
        source: "var notes = client.ListAccountNotes(accountId);\nforeach(AccountNote note in notes)\n{\n    Console.WriteLine(note.Message);\n}\n"
      - lang: Ruby
        source: "params = {\n  limit: 200\n}\naccount_notes = @client.list_account_notes(account_id: account_id, params: params)\naccount_notes.each do |note|\n  puts \"AccountNote: #{note.message}\"\nend\n"
      - lang: Java
        source: "ListAccountNotesParams params = new ListAccountNotesParams();\nfinal Pager<AccountNote> notes = client.listAccountNotes(accountId, params);\n\nfor (AccountNote note : notes) {\n    System.out.println(note.getMessage());\n}\n"
      - lang: PHP
        source: "$options = [\n  'params' => [\n    'limit' => 200\n  ]\n];\n$account_notes = $client->listAccountNotes($account_id, $options);\n\nforeach($account_notes as $note) {\n  echo 'Account note: ' . $note->getMessage() . PHP_EOL;\n}\n"
      - lang: Go
        source: "listParams := &recurly.ListAccountNotesParams{}\naccountNotes, err := client.ListAccountNotes(accountID, listParams)\nif err != nil {\n\tfmt.Println(\"Unexpected error: %v\", err)\n\treturn\n}\n\nfor accountNotes.HasMore() {\n\terr := accountNotes.Fetch()\n\tif e, ok := err.(*recurly.Error); ok {\n\t\tfmt.Printf(\"Failed to retrieve next page: %v\", e)\n\t\tbreak\n\t}\n\tfor i, note := range accountNotes.Data() {\n\t\tfmt.Printf(\"Account Note %3d: %s\\n\",\n\t\t\ti,\n\t\t\tnote.Id,\n\t\t)\n\t}\n}"
      x-readme:
        code-samples:
        - language: node
          code: "const notes = client.listAccountNotes(accountId, { params: { limit: 200 } })\n\nfor await (const note of notes.each()) {\n  console.log(note.message)\n}\n"
          name: Node.js
        - language: python
          code: "params = {\"limit\": 200}\nline_items = client.list_account_line_items(account_id, params=params).items()\nfor line_item in line_items:\n    print(line_item.id)\n"
          name: Python
        - language: csharp
          code: "var notes = client.ListAccountNotes(accountId);\nforeach(AccountNote note in notes)\n{\n    Console.WriteLine(note.Message);\n}\n"
          name: .NET
        - language: ruby
          code: "params = {\n  limit: 200\n}\naccount_notes = @client.list_account_notes(account_id: account_id, params: params)\naccount_notes.each do |note|\n  puts \"AccountNote: #{note.message}\"\nend\n"
          name: Ruby
        - language: java
          code: "ListAccountNotesParams params = new ListAccountNotesParams();\nfinal Pager<AccountNote> notes = client.listAccountNotes(accountId, params);\n\nfor (AccountNote note : notes) {\n    System.out.println(note.getMessage());\n}\n"
          name: Java
        - language: php
          code: "$options = [\n  'params' => [\n    'limit' => 200\n  ]\n];\n$account_notes = $client->listAccountNotes($account_id, $options);\n\nforeach($account_notes as $note) {\n  echo 'Account note: ' . $note->getMessage() . PHP_EOL;\n}\n"
          name: PHP
        - language: go
          code: "listParams := &recurly.ListAccountNotesParams{}\naccountNotes, err := client.ListAccountNotes(accountID, listParams)\nif err != nil {\n\tfmt.Println(\"Unexpected error: %v\", err)\n\treturn\n}\n\nfor accountNotes.HasMore() {\n\terr := accountNotes.Fetch()\n\tif e, ok := err.(*recurly.Error); ok {\n\t\tfmt.Printf(\"Failed to retrieve next page: %v\", e)\n\t\tbreak\n\t}\n\tfor i, note := range accountNotes.Data() {\n\t\tfmt.Printf(\"Account Note %3d: %s\\n\",\n\t\t\ti,\n\t\t\tnote.Id,\n\t\t)\n\t}\n}"
          name: Go
    post:
      tags:
      - Account Note
      operationId: create_account_note
      summary: Create an account note
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/account_id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountNoteCreate'
        required: true
      responses:
        '201':
          description: An account note.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountNote'
        '400':
          description: Bad request; perhaps missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Incorrect site or account ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: A validation error.
          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
  /accounts/{account_id}/notes/{account_note_id}:
    get:
      tags:
      - Account Note
      operationId: get_account_note
      summary: Fetch an account note
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/account_id'
      - $ref: '#/components/parameters/account_note_id'
      responses:
        '200':
          description: An account note.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountNote'
        '404':
          description: Incorrect site, account or note ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples:
      - lang: Node.js
        source: "try {\n  console.log(accountId)\n  const note = await client.getAccountNote(accountId, accountNoteId)\n  console.log('Fetched account note: ', note.message)\n} catch (err) {\n  if (err instanceof recurly.errors.NotFoundError) {\n    // If the request was not found, you may want to alert the user or\n    // just return null\n    console.log('Resource Not Found')\n  } else {\n    // If we don't know what to do with the err, we should\n    // probably re-raise and let our web framework and logger handle it\n    console.log('Unknown Error: ', err)\n  }\n}\n"
      - lang: Python
        source: "try:\n    note = client.get_account_note(account_id, note_id)\n    print(\"Got AccountNote %s\" % note)\nexcept recurly.errors.NotFoundError:\n    # If the resource was not found, you may want to alert the user or\n    # just return nil\n    print(\"Resource Not Found\")\n"
      - lang: .NET
        source: "try\n{\n    AccountNote note = client.GetAccountNote(accountId, accountNoteId);\n    Console.WriteLine($\"Fetched account note: {note.Message}\");\n}\ncatch (Recurly.Errors.NotFound ex)\n{\n    // If the resource was not found\n    // we may want to alert the user or just return null\n    Console.WriteLine($\"Resource Not Found: {ex.Error.Message}\");\n}\ncatch (Recurly.Errors.ApiError ex)\n{\n    // Use ApiError to catch a generic error from the API\n    Console.WriteLine($\"Unexpected Recurly Error: {ex.Error.Message}\");\n}\n"
      - lang: Ruby
        source: "begin\n  note = @client.get_account_note(\n    account_id: account_id,\n    account_note_id: note_id\n  )\n  puts \"Got AccountNote #{note}\"\nrescue Recurly::Errors::NotFoundError\n  # If the resource was not found, you may want to alert the user or\n  # just return nil\n  puts \"Resource Not Found\"\nend\n"
      - lang: Java
        source: "try {\n    final AccountNote note = client.getAccountNote(accountId, accountNoteId);\n    System.out.println(\"Fetched account note: \" + note.getMessage());\n} catch (NotFoundException e) {\n    // If the resource was not found\n    // we may want to alert the user or just return null\n    System.out.println(\"Resource Not Found: \" + e.getError().getMessage());\n} catch (ApiException e) {\n    // Use ApiException to catch a generic error from the API\n    System.out.println(\"Unexpected Recurly Error: \" + e.getError().getMessage());\n}\n"
      - lang: PHP
        source: "try {\n    $note = $client->getAccountNote($account_id, $account_node_id);\n\n    echo 'Got Account Note:' . PHP_EOL;\n    var_dump($note);\n} catch (\\Recurly\\Errors\\NotFound $e) {\n    // Could not find the resource, you may want to inform the user\n    // or just return a NULL\n    echo 'Could not find resource.' . PHP_EOL;\n    var_dump($e);\n} catch (\\Recurly\\RecurlyError $e) {\n    // Something bad happened... tell the user so that they can fix it?\n    echo 'Some unexpected Recurly error happened. Try again later.' . PHP_EOL;\n}\n"
      - lang: Go
        source: "accountNote, err := client.GetAccountNote(accountID, accountNoteID)\nif e, ok := err.(*recurly.Error); ok {\n\tif e.Type == recurly.ErrorTypeNotFound {\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected Recurly error: %v\", e)\n\treturn nil, err\n}\nfmt.Printf(\"Fetched Account Note: %v\", accountNote)"
      x-readme:
        code-samples:
        - language: node
          code: "try {\n  console.log(accountId)\n  const note = await client.getAccountNote(accountId, accountNoteId)\n  console.log('Fetched account note: ', note.message)\n} catch (err) {\n  if (err instanceof recurly.errors.NotFoundError) {\n    // If the request was not found, you may want to alert the user or\n    // just return null\n    console.log('Resource Not Found')\n  } else {\n    // If we don't know what to do with the err, we should\n    // probably re-raise and let our web framework and logger handle it\n    console.log('Unknown Error: ', err)\n  }\n}\n"
          name: Node.js
        - language: python
          code: "try:\n    note = client.get_account_note(account_id, note_id)\n    print(\"Got AccountNote %s\" % note)\nexcept recurly.errors.NotFoundError:\n    # If the resource was not found, you may want to alert the user or\n    # just return nil\n    print(\"Resource Not Found\")\n"
          name: Python
        - language: csharp
          code: "try\n{\n    AccountNote note = client.GetAccountNote(accountId, accountNoteId);\n    Console.WriteLine($\"Fetched account note: {note.Message}\");\n}\ncatch (Recurly.Errors.NotFound ex)\n{\n    // If the resource was not found\n    // we may want to alert the user or just return null\n    Console.WriteLine($\"Resource Not Found: {ex.Error.Message}\");\n}\ncatch (Recurly.Errors.ApiError ex)\n{\n    // Use ApiError to catch a generic error from the API\n    Console.WriteLine($\"Unexpected Recurly Error: {ex.Error.Message}\");\n}\n"
          name: .NET
        - language: ruby
          code: "begin\n  note = @client.get_account_note(\n    account_id: account_id,\n    account_note_id: note_id\n  )\n  puts \"Got AccountNote #{note}\"\nrescue Recurly::Errors::NotFoundError\n  # If the resource was not found, you may want to alert the user or\n  # just return nil\n  puts \"Resource Not Found\"\nend\n"
          name: Ruby
        - language: java
          code: "try {\n    final AccountNote note = client.getAccountNote(accountId, accountNoteId);\n    System.out.println(\"Fetched account note: \" + note.getMessage());\n} catch (NotFoundException e) {\n    // If the resource was not found\n    // we may want to alert the user or just return null\n    System.out.println(\"Resource Not Found: \" + e.getError().getMessage());\n} catch (ApiException e) {\n    // Use ApiException to catch a generic error from the API\n    System.out.println(\"Unexpected Recurly Error: \" + e.getError().getMessage());\n}\n"
          name: Java
        - language: php
          code: "try {\n    $note = $client->getAccountNote($account_id, $account_node_id);\n\n    echo 'Got Account Note:' . PHP_EOL;\n    var_dump($note);\n} catch (\\Recurly\\Errors\\NotFound $e) {\n    // Could not find the resource, you may want to inform the user\n    // or just return a NULL\n    echo 'Could not find resource.' . PHP_EOL;\n    var_dump($e);\n} catch (\\Recurly\\RecurlyError $e) {\n    // Something bad happened... tell the user so that they can fix it?\n    echo 'Some unexpected Recurly error happened. Try again later.' . PHP_EOL;\n}\n"
          name: PHP
        - language: go
          code: "accountNote, err := client.GetAccountNote(accountID, accountNoteID)\nif e, ok := err.(*recurly.Error); ok {\n\tif e.Type == recurly.ErrorTypeNotFound {\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected Recurly error: %v\", e)\n\treturn nil, err\n}\nfmt.Printf(\"Fetched Account Note: %v\", accountNote)"
          name: Go
    delete:
      tags:
      - Account Note
      operationId: remove_account_note
      summary: Delete an account note
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/account_id'
      - $ref: '#/components/parameters/account_note_id'
      responses:
        '204':
          description: Account note deleted.
        '404':
          description: Incorrect site, account or note 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
components:
  parameters:
    account_id:
      name: account_id
      in: path
      description: Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`.
      required: true
      schema:
        type: string
    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'
    ids:
      name: ids
      in: query
      description: "Filter results by their IDs. Up to 200 IDs can be passed at once using\ncommas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`.\n\n**Important notes:**\n\n* The `ids` parameter cannot be used with any other ordering or filtering\n  parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)\n* Invalid or unknown IDs will be ignored, so you should check that the\n  results correspond to your request.\n* Records are returned in an arbitrary order. Since results are all\n  returned at once you can sort the records yourself.\n"
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    account_note_id:
      name: account_note_id
      in: path
      description: Account Note ID.
      required: true
      schema:
        type: string
  schemas:
    AcceptHeaderEnum:
      type: string
      enum:
      - application/vnd.recurly.v2021-02-25
      - application/vnd.recurly.v2021-02-25+json
    AccountNoteList:
      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/AccountNote'
    AccountNote:
      type: object
      required:
      - message
      properties:
        id:
          type: string
          maxLength: 13
          readOnly: true
        object:
          type: string
          title: Object type
          readOnly: true
        account_id:
          type: string
        user:
          $ref: '#/components/schemas/User'
        message:
          type: string
        created_at:
          type: string
          format: date-time
          readOnly: true
    User:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        object:
          type: string
          title: Object type
          readOnly: true
        email:
          type: string
          format: email
        first_name:
          type: string
        last_name:
          type: string
        time_zone:
          type: string
        created_at:
          type: string
          format: date-time
          readOnly: true
        deleted_at:
          type: string
          format: date-time
          readOnly: true
    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
    AccountNoteCreate:
      type: object
      required:
      - message
      properties:
        message:
          type: string
          description: The content of the account note.
    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
  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