Telstra Services API

openapi: 3.2.0
info:
  title: Bandwidth Modification Services API
  version: 0.4.0
  description: '# Introduction

    This OpenAPI document combines the Customer Services, Modify Bandwidth, Fetch Status, and Pricing APIs for Telstra connectivity and product solutions. ## Features

    Connectivity API provides below features. | Feature | | Description |

    |---|---|---|

    |`Retrieve Services` | | Retrieve, filter, and paginate customer services. |

    |`Fetch status` | | Fetch status of request by unique RequestId. |

    |`Modify Bandwidth` | | Submit bandwidth modification requests for Telstra Internet Direct , Adaptive Fibre and Adaptive Broadband.|

    |`Pricing API` | | Retirves list prices for the given product.Filter with product and product specific attributes|


    ## Version Control

    This section will be used to keep track of the template version history. | Version | Date | Summary of Change. | 0.4.0 | 2026-04-10 | added AB modify plan API end point and uplift of Get services


    | 0.3.0 | 2026-03-10 | added Pricing API in the scope

    | 0.2.0 | 2026-02-28 | Combined release of specification with AF modify BW API included in the scope


    | 0.1.0 | 2026-01-28 | Combined release of specification with Retrieve Services, TID BW modify, and Fetch Status (generic endpoint)

    | 0.0.0 | 2025-12-15 | Initial release of the API specification for Retrieve Service, Modify TID BW, and Fetch Status


    ##


    ---


    ## Get Services API

    The Retrieve Services API provides a unified interface for discovering and viewing Telstra connectivity services associated with an account. It returns service details, identifiers, status, and product-specific characteristics in a consistent format, enabling customers to inventory, manage, and monitor their services. -----


    ## Modify APIs

    The Modify Service API allows customers to submit changes to an existing Telstra connectivity service. Supported modifications are validated against product-specific business rules and service constraints before a modification request is created. The API provides a consistent and secure mechanism to manage service changes while maintaining service integrity and compliance with Telstra product policies. ------


    ## Fetch Status API

    The Fetch Status API enables customers to retrieve the current status of previously submitted modification requests. It provides visibility into the order fulfilment lifecycle by returning status information. This allows customers to monitor request progress and determine when an modification has been successfully completed. The API supports secure access through OAuth2 and follows Telstra''s standards for headers, error handling, and documentation. -------


    ## Pricing API

    The Pricing API provides a unified interface to retrieve Telstra product pricing information. The prices returned depend on your commercial relationship with Telstra:

    - If a Frame Agreement (FA) is in effect, pricing applicable under that agreement will be returned. - If no Frame Agreement (FA) is in effect, the standard list price will be returned. **All prices returned by this API exclude GST**


    .**Pricing made available through the Price API is confidential and must only be used for your internal business purposes in connection with your Telstra services.**


    The API supports filtering by product, charge type, and product-specific attributes, and returns results in a consistent, offset-based paginated format. The API is designed for both broad and fine-grained price discovery, enabling clients to:

    - Retrieve list prices for all or specific products

    - Filter results using product attributes (e.g., bandwidth, zone, variant)

    - Select between recurring and one-off charges

    - Page through large result sets using `offset` and `limit` query parameters (client-driven pagination)

    - Receive detailed error information in a standard envelope


    This API is suitable for integration into quoting tools, product catalogs, and customer-facing applications where up-to-date, accurate pricing is required.'
servers:
- url: https://prod.okapi.ogw.evolve.okapi.telstra.com/connectivity/v0
  description: Telstra Products API (Production)
security:
- OAuth2ClientCredentials: []
tags:


# --- truncated at 32 KB (50 KB total) ---
# Full source: https://artifacts.apis.io/telstra/openapi/telstra-services-api-openapi.yml