Subscriptions

Gets all seller subscriptions

Returns all subscription data corresponding to the seller of the request

get/v1/subscriptions

Request

Base URL
https://api.edubank.com.br (the document declares no server; this is the origin it was published from)
Auth
- API key in header x-api-key
- or API key in header authorization
TypeScript
https://skmtc.dev/edubank/apis/api-edubank/docs/v1/subscriptions/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pagestring required

Select the page

limitstring required

Limits the number of objects returned, which can be between 1 and 100

sort'ASC' | 'DESC' required

Determine how to sort the list by object creation date

reference_idstring

Subscription reference_id

Response

The record has been successfully getted

pagenumber required

Selected page

limitnumber required

Selected limit per page

sort'ASC' | 'DESC' required

Selected sort list

last_pagenumber required

Last page

max_itemsnumber required

Total items for the defined filter

Example response

{
  "items": [
    {
      "created_at": "2026-10-01T23:59:59+00:00",
      "updated_at": "2026-10-01T23:59:59+00:00",
      "seller_id": "117a97d225337dmf96bb0b883a1019sj",
      "reference_id": "my_subscription_728",
      "buyer_id": "39c784f7bf754698aa078a261cf42439",
      "status": "PROPOSAL",
      "expires_in": "2026-10-01",
      "charge": {
        "start_date": "2026-10-01",
        "frequency": "MONTHLY",
        "duration": 1,
        "amount": 10000
      },
      "notification_url": "https://api.domain.com.br/v1/edubank-notification",
      "subscription_permission": {
        "authorized_in": "2026-10-01T23:59:59+00:00"
      },
      "references": [
        {
          "due_date": "2026-10-01",
          "reference_id": "my_tuition_996"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.