API Overview Resources Schemas

Consumptions

Rating API for retrieving subscriptions consumption info

Get subscription general consumptions info

Show subscription general consumptions info (bonus and monetary balances).

This service will provide information for prepaid and postpaid subscriptions.
Prepaid subscriptions
- This service will inform only about the subscription monetary balance at the request moment.
Postpaid subscriptions
- This service will inform about monetary and bonus balances of the current billing cycle, i.e., from the period between 1st day of the current billing cycle and the request moment.
- This service will only inform about subscriptions that have been active during the current billing cycle. For terminated subscriptions in previous billing cycles, no information will be offered.

GET /orgs/{orgId}/subscription/{subscriptionId}/consumptions

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	Executes the request in the context of the given organization
subscriptionId	path	string	true	Executes the request in the context of the given subscription

Request example

1
2
3
4
5



curl -X GET https://billing.masstack.com/v1/orgs/masmovil/subscription/123456789/consumptions \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Subscription balances details	SubscriptionResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
404	Not Found	The specified resource was not found	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO

Get subscription consumptions details

Show subscription consumptions details (subscription cdrs details). Consumption details could be filtered by period and traffic type ('data', 'sms', 'voice').

This service will provide information for prepaid and postpaid subscriptions.
Prepaid subscriptions
- If a period is not specified, this service will offer consumption details for the last 30 days.
- If a period is specified, this service will offer consumption details for a maximum of the last 90 days. For example, if we are at '2021-09-15T16:01:03Z' (note that dates are in UTC) we could request a maximum period that spans from '2021-06-17T16:01:03Z' to '2021-09-15T16:01:03Z'. Out of this period, service will return an error indicating that the requested period is outside the limits.
Postpaid subscriptions
- If a period is not specified, this service will offer consumption details of the current billing cycle, that is, the period between beginning of the billing cycle and the request moment.
- If a period is specified, this service will offer consumption details for a maximum of 3 billing cycles prior to the current one. For example, if we are at '2021-09-15T16:01:03Z' (note that dates are in UTC) we could request a maximum period that spans from '2021-05-31T22:00:00Z' to '2021-09-15T16:01:03Z' for a tenant whose billing cycle start on the first day of the month. Out of this period, the service will return an error indicating that the requested period is outside the limits.

GET /orgs/{orgId}/subscription/{subscriptionId}/consumptions/details

Parameters

Name	In	Type	Required	Description
type	query	string	false	Cdr type used as filter
fromDate	query	string(date-time)	false	From datetime used as filter
toDate	query	string(date-time)	false	To datetime used as filter
orgId	path	string	true	Executes the request in the context of the given organization
subscriptionId	path	string	true	Executes the request in the context of the given subscription

Enumerated Values

Property	Values
type	one of [data, sms, voice]

Request example

1
2
3
4
5



curl -X GET https://billing.masstack.com/v1/orgs/masmovil/subscription/123456789/consumptions/details?type='data'&fromDate='2021-10-10T22:00:00Z'&toDate='2021-10-20T22:00:00Z' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Subscription cdrs details	CdrsByTypeResponseDTO
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
404	Not Found	The specified resource was not found	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO

Endpoints

Consumptions

Movements

Refunds

Invoices

LocationTax