Spending Limit Retrieval Subscriptions

/subscriptions

POST

Creates a new individual spending limit retrieval subscription.

Individual Spending Limit Retrieval Subscription

/subscriptions/{subscriptionId}

PUT

Modifies an existing subscription (e.g. addition of additional policy counters).

DELETE

Deletes an individual subscription.

apiRoot

string

See clause 5.1

n/a

SpendingLimitContext

M

1

Contains the information for the creation of a new individual spending limit retrieval subscription.

SpendingLimitStatus

M

1

201 Created

The spending limit subscription was created and spending limit reports are provided.

ProblemDetails

O

0..1

400 Bad Request

(NOTE 2)

NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the POST method shall also apply.

NOTE 2: In addition to protocol and application errors which are specified in clause 5.2.7.2 of 3GPP TS 29.500 [4], specific errors are described in clause 5.7.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId}

apiRoot

string

See clause 5.1

subscriptionId

string

Identifies a subscription to the CHF spending limit control retrieval service.

n/a

SpendingLimitContext

M

1

Modifies the existing individual spending limit retrieval subscription.

SpendingLimitStatus

M

1

200 OK

Successful case: The individual spending limit subscription was modified and spending limit reports are provided.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual Spending Limit Retrieval Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CHF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual Spending Limit Retrieval Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CHF (service) instance.

Applicable if the feature "ES3XX" is supported.

ProblemDetails

O

0..1

400 Bad Request

(NOTE 2)

NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the PUT method shall also apply.

NOTE 2: In addition to protocol and application errors which are specified in clause 5.2.7.2 of 3GPP TS 29.500 [4], specific errors are described in clause 5.7.

Location

string

M

1

An alternative URI of the resource located in an alternative CHF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located in an alternative CHF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected

n/a

n/a

n/a

204 No Content

Successful case: The individual spending limit subscription matching the subscriptionId was deleted.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual Spending Limit Retrieval Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CHF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual Spending Limit Retrieval Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CHF (service) instance.

Applicable if the feature "ES3XX" is supported.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the DELETE method shall also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative CHF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located in an alternative CHF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected

Spending limit notification

{notifUri}/notify

notify (POST)

Counter Status changes notification.

Subscription Termination

{notifUri}/terminate

terminate (POST)

Indication of subscription termination.

notifUri

Uri

The Notification Uri as assigned by the NF service consumer during the subscription service operation and described within the SpendingLimitContext data type (see table 5.6.2.2-1).

n/a

SpendingLimitStatus

M

1

Provides information about the statuses of policy counters.

n/a

204 No Content

The receipt of the notification is acknowledged.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Spending limit report. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Spending limit report. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

Applicable if the feature "ES3XX" is supported.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the POST method shall also apply.

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected

notifUri

Uri

The Notification Uri as assigned by the NF service consumer during the subscription service operation and described within the SpendingLimitContext data type (see table 5.6.2.2-1).

n/a

SubscriptionTerminationInfo

M

1

Provides information about the deletion of the resource.

n/a

204 No Content

The receipt of the Notification is acknowledged.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

Applicable if the feature "ES3XX" is supported.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the POST method shall also apply.

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected

SpendingLimitContext

5.6.2.2

Describes the subscription data structure required for an individual CHF spending limit subscription.

SpendingLimitStatus

5.6.2.3

Describes the data structure presenting the statuses of policy counters.

PolicyCounterInfo

5.6.2.4

Describes the data structure presenting the policy counter status.

PendingPolicyCounterStatus

5.6.2.5

Describes the data structure presenting the pending policy counter status.

PolicyCounterId

5.6.3.2

Identifies a policy counter.

SubscriptionTerminationInfo

5.6.2.6

Describes the data structure presenting the indication of the termination of the subscription.

TerminationCause

5.6.3.3

Represents the types of causes for requesting the termination of the subscription.

DateTime

3GPP TS 29.571 [11]

String with format "date-time" as defined in OpenAPI Specification [9].

Uri

3GPP TS 29.571 [11]

Supi

3GPP TS 29.571 [11]

Gpsi

3GPP TS 29.571 [11]

RedirectResponse

3GPP TS 29.571 [11]

Contains redirection related information.

ES3XX

SupportedFeatures

3GPP TS 29.571 [11]

Used to negotiate the applicability of the optional features defined in table 5.8-1.

supi

Supi

C

0..1

The Subscription Permanent Identifier (Supi) shall be present within the initial spending limit retrieval procedure (creation of a new individual subscription) and intermediate spending limit retrieval procedure (modification of an existing subscription).

gpsi

Gpsi

O

0..1

The Generic Public Subscription Identifier (Gpsi) shall contain either an External Id or an MSISDN. It may be present within the initial spending limit retrieval procedure (creation of a new individual subscription) and intermediate spending limit retrieval procedure (modification of an existing subscription).

policyCounterIds

array(PolicyCounterId)

O

1..N

This is a list of policy counter identifier(s), which identifies policy counters maintained per subscriber within the CHF.

notifUri

Uri

C

0..1

This attribute identifies the recipient of spending limit notifications sent to the NF service consumer by the CHF. The notifUri shall be present within the initial spending limit retrieval procedure (creation of a new individual subscription and within the intermediate spending limit retrieval procedure (modification of an existing subscription).

notifId

string

C

0..1

Notification Correlation ID assigned by the NF service consumer. It shall be included if the NotificationCorrelation feature is supported, the notifUri does not encode the notification correlation Id, and the NF service consumers require multiple subscriptions for the same SUPI, e.g. UE accesses multiple network slices.

NotificationCorrelation

expiry

DateTime

O

0..1

The expiry time may be included in a subscription request. When present, this IE shall represent the longest duration time after which the subscription shall become invalid.

SubscriptionExpirationTimeControl

supportedFeatures

SupportedFeatures

C

0..1

The list of supported features as described in clause 5.8 shall be supplied by the NF service consumer in the POST request that request the creation of a spending limit report resource and intermediate spending limit retrieval procedure (modification of an existing subscription).

supi

Supi

O

0..1

The Subscription Permanent Identifier (Supi) shall be present within the callback notify service operation (notification of the status of subscribed policy counters).

notifId

string

C

0..1

Notification Correlation ID assigned by the NF service consumer. It shall be included if provided during the subscription within the SpendingLimitContext data type.

NotificationCorrelation

statusInfos

map(PolicyCounterInfo)

C

1..N

Status of the requested policy counters. The key of the map is the attribute "policyCounterId".

It may be omitted when the feature SubscriptionExpirationTimeControl is supported and the CHF only requires to update the "expiry" attribute.

expiry

DateTime

C

0..1

This expiry time shall be included in a subscription response, if the expiry time was included in the request.

It may be included in a subscription response and notification request based on operator policies for the control in the CHF of the subscription duration.

SubscriptionExpirationTimeControl

supportedFeatures

SupportedFeatures

C

0..1

If the supportedFeatures is included in the request by the NF service consumer, it shall be supplied in the reply of the corresponding request by the CHF.

policyCounterId

PolicyCounterId

M

1

Identifies the requested policy counter.

currentStatus

string

M

1

Identifies the policy counter status applicable for a specific policy counter identified by the policyCounterId. The values (e.g. valid, invalid or any other status) are not specified. The interpretation and actions related to the defined values are out of scope of 3GPP.

penPolCounterStatuses

array(PendingPolicyCounterStatus)

O

1..N

Provides the pending policy counter status.

policyCounterStatus

string

M

1

Identifies the policy counter status applicable for a specific policy counter identified by the PolicyCounterId. The values (e.g. valid, invalid or any other status) are not specified. The interpretation and actions related to the defined values are out of scope of 3GPP.

activationTime

DateTime

M

1

Indicates the time at which the pending policy counter status becomes the current status of a policy counter.

supi

Supi

M

1

Subscription Permanent Identifier.

notifId

string

C

0..1

Notification Correlation ID assigned by the NF service consumer. It shall be included if provided during the subscription within the SpendingLimitContext data type.

NotificationCorrelation

termCause

TerminationCause

O

0..1

Indicates the cause for requesting the termination of the subscription to policy counter status changes.

PolicyCounterId

string

Identifies a policy counter.

REMOVED_SUBSCRIBER

The subscriber identified by the SUPI has been removed from the CHF.

USER_UNKNOWN

400 Bad Request

The subscriber specified in the request is not known at the CHF and the subscription cannot be created.

NO_AVAILABLE_POLICY_COUNTERS

400 Bad Request

There are no policy counters available for the subscriber at the CHF

UNKNOWN_POLICY_COUNTERS

400 Bad Request

The policy counter identifiers in the request are not known at the CHF.

NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses.

1

SubscriptionExpirationTimeControl

Indicates the support of a expiry time to control the time duration of the subscription to changes of policy counters status.

2

NotifiationCorrelation

Indicates the support of the explicit indication of the notification correlation id

3

ES3XX

Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [4] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [4].