3GPP Individual chargeable party resource Operation API

openapi: 3.2.0
info:
  title: 3gpp-chargeable-party Individual chargeable party resource Operation API
  version: 1.4.1
  description: "API for Chargeable Party management.  \n© 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-chargeable-party/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
tags:
- name: Individual chargeable party resource Operation
paths:
  /{scsAsId}/transactions/{transactionId}:
    get:
      summary: Read a chargeable party resource for a given SCS/AS and a transaction Id.
      operationId: FetchIndChargeablePartyTransaction
      tags:
      - Individual chargeable party resource Operation
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of SCS/AS
        required: true
        schema:
          type: string
      - name: transactionId
        in: path
        description: Identifier of transaction
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK (successful query of a chargeable party resource)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeableParty'
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '406':
          $ref: TS29122_CommonData.yaml#/components/responses/406
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
    patch:
      summary: Updates a existing chargeable party resource for a given SCS/AS and transaction Id.
      operationId: UpdateChargeablePartyTransaction
      tags:
      - Individual chargeable party resource Operation
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of SCS/AS
        required: true
        schema:
          type: string
      - name: transactionId
        in: path
        description: Identifier of transaction
        required: true
        schema:
          type: string
      requestBody:
        description: representation of the chargeable party resource to be udpated in the SCEF
        required: true
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/ChargeablePartyPatch'
      responses:
        '200':
          description: successful update of a chargeable party resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeableParty'
        '204':
          description: No Content
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '411':
          $ref: TS29122_CommonData.yaml#/components/responses/411
        '413':
          $ref: TS29122_CommonData.yaml#/components/responses/413
        '415':
          $ref: TS29122_CommonData.yaml#/components/responses/415
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
    delete:
      summary: Deletes a chargeable party resource for a given SCS/AS and a transcation Id.
      operationId: DeleteChargeablePartyTransaction
      tags:
      - Individual chargeable party resource Operation
      parameters:
      - name: scsAsId
        in: path
        description: Identifier of SCS/AS
        required: true
        schema:
          type: string
      - name: transactionId
        in: path
        description: Identifier of transaction
        required: true
        schema:
          type: string
      responses:
        '204':
          description: successful deletion of an resouce of chargeable party
        '200':
          description: OK (Successful deletion of the existing subscription)
          content:
            application/json:
              schema:
                $ref: TS29122_CommonData.yaml#/components/schemas/NotificationData
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
components:
  schemas:
    ChargeablePartyPatch:
      description: Represents a modification request of a chargeable party resource.
      type: object
      properties:
        flowInfo:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/FlowInfo
          minItems: 1
          description: Describes the IP flows.
        exterAppId:
          type: string
          description: Identifies the external Application Identifier.
        ethFlowInfo:
          type: array
          items:
            $ref: TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription
          minItems: 1
          description: Identifies Ethernet packet flows.
        sponsoringEnabled:
          type: boolean
          description: 'Indicates whether the sponsoring data connectivity is enabled (true) or not (false).

            '
        referenceId:
          $ref: TS29122_CommonData.yaml#/components/schemas/BdtReferenceId
        usageThreshold:
          $ref: TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm
        notificationDestination:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        events:
          description: Represents the list of event(s) to which the SCS/AS requests to subscribe to.
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/Event
          minItems: 1
    ChargeableParty:
      description: Represents the configuration of a chargeable party.
      type: object
      properties:
        self:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        supportedFeatures:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
        dnn:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnn
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        notificationDestination:
          $ref: TS29122_CommonData.yaml#/components/schemas/Link
        requestTestNotification:
          type: boolean
          description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise.
        websockNotifConfig:
          $ref: TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig
        exterAppId:
          type: string
          description: Identifies the external Application Identifier.
        ipv4Addr:
          $ref: TS29122_CommonData.yaml#/components/schemas/Ipv4Addr
        ipDomain:
          type: string
        ipv6Addr:
          $ref: TS29122_CommonData.yaml#/components/schemas/Ipv6Addr
        macAddr:
          $ref: TS29571_CommonData.yaml#/components/schemas/MacAddr48
        flowInfo:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/FlowInfo
          minItems: 1
          description: Describes the application flows.
        ethFlowInfo:
          type: array
          items:
            $ref: TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription
          minItems: 1
          description: Identifies Ethernet packet flows.
        sponsorInformation:
          $ref: TS29122_CommonData.yaml#/components/schemas/SponsorInformation
        sponsoringEnabled:
          type: boolean
          description: 'Indicates whether the sponsoring data connectivity is enabled (true) or not (false).

            '
        referenceId:
          $ref: TS29122_CommonData.yaml#/components/schemas/BdtReferenceId
        servAuthInfo:
          $ref: TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ServAuthInfo
        usageThreshold:
          $ref: TS29122_CommonData.yaml#/components/schemas/UsageThreshold
        events:
          type: array
          items:
            $ref: TS29122_CommonData.yaml#/components/schemas/Event
          minItems: 1
          description: Represents the list of event(s) to which the SCS/AS requests to subscribe to.
      required:
      - notificationDestination
      - sponsorInformation
      - sponsoringEnabled
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}
externalDocs:
  description: 3GPP TS 29.122 V19.6.0 T8 reference point for Northbound APIs
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/