Developer Docs
Hubex
Technical Changelog
Version 1.1.76

API Docs Version 1.1.76

What's New

GET /address-lookup/search

Utilizes the Search API for different ordnance survey providers

GET /company-lookup/search

Search company information

GET /company-lookup/retrieve-directors-info/{company_id}

Retrieve directors info

What's Changed

GET /payment/invoices/search

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /payment/invoices/search-by-query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /payment/invoices/search-by-metadata

Parameters:

Added: expand in query

Specifies which fields in the response should be expanded.

Request:

Changed content type : application/json

  • Deleted property expand (array)

    Specifies which fields in the response should be expanded.

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /payment/invoices/{invoice_id}/send

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /payment/invoices/{invoice_id}/void

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /payment/invoice-items

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /payment/invoice-items

Request:

Changed content type : application/json

  • Changed property period (object)

    The period associated with this invoice item. When set to different values, the period will be rendered on the invoice.

    New optional properties:

    • end

    • start

    • Changed property end (string -> integer)

      The end of the period, which must be greater than or equal to the start. This value is inclusive.

    • Changed property start (string -> integer)

      The start of the period. This value is inclusive

POST /payment/invoice-items/{invoice_item_id}

Request:

Changed content type : application/json

  • Changed property period (object)

    The period associated with this invoice item. When set to different values, the period will be rendered on the invoice.

    New optional properties:

    • end

    • start

    • Changed property end (string -> integer)

      The end of the period, which must be greater than or equal to the start. This value is inclusive.

    • Changed property start (string -> integer)

      The start of the period. This value is inclusive

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /events/{event_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /events

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /payment/invoices

Parameters:

Changed: customer in query

Only return invoices for the customer specified by this customer ID.

Changed: status in query

The status of the invoice, one of draft, open, paid, uncollectible, or void.

Changed: subscription in query

Only return invoices for the subscription specified by this subscription ID.

Changed: collection_method in query

The collection method of the invoice to retrieve. Either charge_automatically or send_invoice.

Changed: created in query

A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp.

Changed: due_date in query

A filter on the list based on the object due_date field. The value can be a string with an integer Unix timestamp.

Changed: ending_before in query

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

Changed: limit in query

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Changed: starting_after in query

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /payment/invoices

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /payment/invoices/{invoice_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

PATCH /payment/invoices/{invoice_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /payment/invoices/upcoming

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /api/verify-address/{address}

Parameters:

Added: x-api-version in header

API version. e.g 1.1 or 1.0

GET /configuration

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property address_lookup (object)

      Configuration for Address Lookup

      • Property ordnance_survey (object)

        Ordnance Survey UK Address Lookup Configuration

        • Property api_url (string)

          API base url for Ordnance Survey UK Address Lookup

        • Property api_key (string)

          API Key for Ordnance Survey UK Address Lookup

    • Added property company_lookup (object)

      Configuration for Company lookup

      • Property companies_house (object)

        UK Company Lookup Configuration

        • Property api_url (string)

          API Base URL for UK Company Lookup

        • Property username (string)

          Username for UK Company Lookup

        • Property password (string)

          Password for UK Company Lookup

POST /configuration

Request:

Changed content type : application/json

  • Added property address_lookup (object)

  • Added property company_lookup (object)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property address_lookup (object)

      Configuration for Address Lookup

    • Added property company_lookup (object)

      Configuration for Company lookup

PATCH /configuration

Request:

Changed content type : application/json

  • Added property address_lookup (object)

  • Added property company_lookup (object)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property address_lookup (object)

      Configuration for Address Lookup

    • Added property company_lookup (object)

      Configuration for Company lookup

Version 1.1.77Version 1.1.75