Skip to main content
POST
/
public
/
{user_id}
/
subscriptions
/
{subscription_uuid}
/
terminate
Terminate Subscription
curl --request POST \
  --url https://apigw.ipxo.com/ecommerce/public/{user_id}/subscriptions/{subscription_uuid}/terminate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "end_of_period",
  "reason": "rzrjuepvjfmommbemp",
  "details": "l",
  "meta": {
    "use_again": true
  }
}
'
{
  "data": {
    "uuid": "1e16b4f8-6269-337a-bd95-581ac26d5dbc",
    "type": "immediate",
    "status": "completed",
    "reason": "Fugiat nesciunt in eos.",
    "details": "Occaecati et aliquam quia omnis dolorem magnam. Sapiente aut consequatur molestiae vitae. Delectus consequatur aut quia voluptas in.",
    "meta": {
      "use_again": true
    },
    "requested_at": "2026-03-11T14:05:32.0000000+00:00",
    "terminated_at": "2026-03-03T14:05:32.0000000+00:00"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

user_id
string
required

The ID of the user.

subscription_uuid
string
required

Body

application/json
type
enum<string>
required
Available options:
end_of_period
Example:

"end_of_period"

reason
string
required

Must not be greater than 255 characters.

Example:

"rzrjuepvjfmommbemp"

meta
object
required

The meta data of the termination request.

Example:
{ "use_again": true }
details
string | null

Must not be greater than 600 characters.

Example:

"l"

Response

200 - application/json
data
object