Subscriptions

Operations related to subscriptions

Get subscriptions

get

Retrieves information about your subscriptions. Use the page parameter to paginate results. Set only_recurring_subscription to true to retrieve only recurring subscriptions. Optionally, filter by a specific user using the identifier parameter.

Accepted identifiers: email, username, eosid, ue4_id, steam_username, steam_id, player_id, minecraft_uuid, discord_id, discord_username, fivem_xPlayer_id, fivem_citizen_id, minecraft_username.

Authorization:

• Requires a valid JWT Bearer token.

• The token must include the permission: read-subscriptions.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

The page number to retrieve.

Default: 1

max_pageintegerOptional

The maximum number of elements per page. This number must be between 5-50.

Default: 50

only_recurring_subscriptionbooleanOptional

Include only recurring subscriptions.

Default: false

identifierstringOptional

Specify an identifier for a user to filter subscriptions. If omitted, subscriptions for all users will be included.

Responses

200

Successful operation

application/json

subscription_countnumberOptionalExample: 120

403

Missing or invalid Tip4Serv API Key

application/json

500

Internal server error

application/json

get/store/subscriptions

GET /v1/store/subscriptions HTTP/1.1
Host: api.tip4serv.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "subscriptions": [
    {
      "id": 1,
      "name": "VIP+ Subscription",
      "status": "text",
      "price": 6.49,
      "onetime": false,
      "username": "Duster",
      "start_date": 1760980455708,
      "next_payment": 1761674734637,
      "expire_date": 1761674734637,
      "unsubscribed": false,
      "duration_periodicity": "month",
      "period_num": 3,
      "currency": "USD",
      "details_page": "https://tip4serv.com/dashboard/subscription-details?id=1"
    }
  ],
  "subscription_count": 120
}

Unsubscribe

patch

Unsubscribes a user from a subscription identified by id.

Authorization:

• Requires a valid JWT Bearer token.

• The token must include the permission: update-subscriptions.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idnumberRequired

The ID of the subscription.

Responses

200

Successful operation.

application/json

statusnumberOptionalExample: 200

messagestringOptionalExample: You have successfully unsubscribed from your subscription.

400

Error in your request

application/json

403

Didn't provide a valid Tip4Serv API Key

application/json

404

Active subscription was not found.

application/json

500

Internal Server Error

application/json

patch/store/subscription/{id}/unsubscribe

PATCH /v1/store/subscription/{id}/unsubscribe HTTP/1.1
Host: api.tip4serv.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": 200,
  "message": "You have successfully unsubscribed from your subscription."
}