Skip to main content
GET
/
api
/
v1
/
subscription_cancellation
/
current_month
/
{client_id}
Get cancellations by client ID (defaults to current month)
curl --request GET \
  --url https://api.raul.ugps.io/api/v1/subscription_cancellation/current_month/{client_id} \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "cancellation_reason_id": 123,
    "date": "2023-11-07T05:31:56Z",
    "subscription_detail_id": "<string>",
    "cancellation_cost": {},
    "monthly_payments": {},
    "subscription_currency_id": {},
    "observations": {},
    "cancellationReason": {
      "cancellation_reason_id": 123,
      "reason": "<string>"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Bearer token authentication

Path Parameters

​
client_id
string
required

Client UUID

Query Parameters

​
periodo
string

Filter by period YYYY-MM (defaults to current month)

Response

200 - application/json

List of cancellations for the period

​
id
number
required
​
cancellation_reason_id
number
required
​
date
string<date-time>
required
​
subscription_detail_id
string
required
​
cancellation_cost
object
​
monthly_payments
object
​
subscription_currency_id
object
​
observations
object
​
cancellationReason
object