find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/tm-forum-billingcyclespecification-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Account Management Billing Cycle Specification API
  description: This is Swagger UI environment generated for the TMF Account Management specification
  version: 4.0.0
servers:
- url: https://serverRoot/tmf-api/accountManagement/v4/
tags:
- name: billingCycleSpecification
paths:
  /billingCycleSpecification:
    get:
      operationId: listBillingCycleSpecification
      summary: List or find BillingCycleSpecification objects
      description: This operation list or find BillingCycleSpecification entities
      tags:
      - billingCycleSpecification
      parameters:
      - name: fields
        description: Comma-separated properties to be provided in response
        required: false
        in: query
        schema:
          type: string
      - name: offset
        description: Requested index for start of resources to be provided in response
        required: false
        in: query
        schema:
          type: integer
      - name: limit
        description: Requested number of resources to be provided in response
        required: false
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: Success
          headers:
            X-Result-Count:
              description: Actual number of items returned in the response body
              schema:
                type: integer
            X-Total-Count:
              description: Total number of items matching criteria
              schema:
                type: integer
          content:
            application/json;charset=utf-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BillingCycleSpecification'
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Method Not allowed
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: createBillingCycleSpecification
      summary: Creates a BillingCycleSpecification
      description: This operation creates a BillingCycleSpecification entity.
      tags:
      - billingCycleSpecification
      responses:
        '201':
          description: Created
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/BillingCycleSpecification'
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Method Not allowed
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/BillingCycleSpecification_Create'
        description: The BillingCycleSpecification to be created
        required: true
  /billingCycleSpecification/{id}:
    get:
      operationId: retrieveBillingCycleSpecification
      summary: Retrieves a BillingCycleSpecification by ID
      description: This operation retrieves a BillingCycleSpecification entity. Attribute selection is enabled for all first level attributes.
      tags:
      - billingCycleSpecification
      parameters:
      - name: id
        description: Identifier of the BillingCycleSpecification
        required: true
        in: path
        schema:
          type: string
      - name: fields
        description: Comma-separated properties to provide in response
        required: false
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/BillingCycleSpecification'
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Method Not allowed
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
    patch:
      operationId: patchBillingCycleSpecification
      summary: Updates partially a BillingCycleSpecification
      description: This operation updates partially a BillingCycleSpecification entity.
      tags:
      - billingCycleSpecification
      parameters:
      - name: id
        description: Identifier of the BillingCycleSpecification
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Updated
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/BillingCycleSpecification'
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Method Not allowed
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/BillingCycleSpecification_Update'
        description: The BillingCycleSpecification to be updated
        required: true
    delete:
      operationId: deleteBillingCycleSpecification
      summary: Deletes a BillingCycleSpecification
      description: This operation deletes a BillingCycleSpecification entity.
      tags:
      - billingCycleSpecification
      parameters:
      - name: id
        description: Identifier of the BillingCycleSpecification
        required: true
        in: path
        schema:
          type: string
      responses:
        '204':
          description: Deleted
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Method Not allowed
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
      type: object
      required:
      - code
      - reason
      properties:
        code:
          type: string
          description: Application relevant detail, defined in the API or a common list.
        reason:
          type: string
          description: Explanation of the reason for the error which can be shown to a client user.
        message:
          type: string
          description: More details and corrective actions related to the error which can be shown to a client user.
        status:
          type: string
          description: HTTP Error code extension
        referenceError:
          type: string
          format: uri
          description: URI of documentation describing the error.
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class.
        '@schemaLocation':
          type: string
          format: uri
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name.
    BillingCycleSpecification_Create:
      type: object
      description: 'A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.

        Skipped properties: id,href'
      required:
      - name
      properties:
        billingDateShift:
          type: integer
          description: An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
        billingPeriod:
          type: string
          description: 'A billing time period. It can be recurring, for example: week, month, quarter of year, year .'
        chargeDateOffset:
          type: integer
          description: An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
        creditDateOffset:
          type: integer
          description: An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
        description:
          type: string
          description: An explanation regarding this billing cycle specification
        frequency:
          type: string
          description: Frequency of the billing cycle (monthly for instance)
        mailingDateOffset:
          type: integer
          description: An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
        name:
          type: string
          description: A short descriptive name
        paymentDueDateOffset:
          type: integer
          description: An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
        validFor:
          $ref: '#/components/schemas/TimePeriod'
          description: The period for which the billing specification cycle is valid
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class
        '@schemaLocation':
          type: string
          format: uri
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name
    TimePeriod:
      type: object
      description: A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
      properties:
        endDateTime:
          type: string
          format: date-time
          description: End of the time period, using IETC-RFC-3339 format
        startDateTime:
          type: string
          format: date-time
          description: Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end
    BillingCycleSpecification_Update:
      type: object
      description: 'A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.

        Skipped properties: id,href'
      required:
      - name
      properties:
        billingDateShift:
          type: integer
          description: An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
        billingPeriod:
          type: string
          description: 'A billing time period. It can be recurring, for example: week, month, quarter of year, year .'
        chargeDateOffset:
          type: integer
          description: An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
        creditDateOffset:
          type: integer
          description: An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
        description:
          type: string
          description: An explanation regarding this billing cycle specification
        frequency:
          type: string
          description: Frequency of the billing cycle (monthly for instance)
        mailingDateOffset:
          type: integer
          description: An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
        name:
          type: string
          description: A short descriptive name
        paymentDueDateOffset:
          type: integer
          description: An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
        validFor:
          $ref: '#/components/schemas/TimePeriod'
          description: The period for which the billing specification cycle is valid
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class
        '@schemaLocation':
          type: string
          format: uri
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name
    BillingCycleSpecification:
      type: object
      description: A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
      required:
      - name
      properties:
        id:
          type: string
          description: Unique identifier of the billing cycle specification
        href:
          type: string
          description: Reference of the billing cycle specification
        billingDateShift:
          type: integer
          description: An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
        billingPeriod:
          type: string
          description: 'A billing time period. It can be recurring, for example: week, month, quarter of year, year .'
        chargeDateOffset:
          type: integer
          description: An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
        creditDateOffset:
          type: integer
          description: An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
        description:
          type: string
          description: An explanation regarding this billing cycle specification
        frequency:
          type: string
          description: Frequency of the billing cycle (monthly for instance)
        mailingDateOffset:
          type: integer
          description: An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
        name:
          type: string
          description: A short descriptive name
        paymentDueDateOffset:
          type: integer
          description: An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
        validFor:
          $ref: '#/components/schemas/TimePeriod'
          description: The period for which the billing specification cycle is valid
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class
        '@schemaLocation':
          type: string
          format: uri
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name